UserInfo

UserInfo
User Info

The identity, type, and roles of an authenticated user, as returned by GET /iam/current-user-info.

JSON Example 
{
    "name": "string",
    "display_name": "string",
    "user_type": "string",
    "password_status": "string",
    "password_expiration_timestamp": 0,
    "roles": [
        {
            "role": "string",
            "display_name": "string"
        }
    ]
}
string
name
Optional

The user or group's name.

string
display_name
Optional

The human-readable name for this user or group, suitable for showing in a UI.

UserType
user_type
Optional

Identifies whether an identity is a local Installer account, a remote user authenticated through a configured LDAP identity source, or a remote LDAP group.

Enumeration: LOCAL_USER, REMOTE_USER, REMOTE_GROUP
PasswordStatus
password_status
Optional

The password expiry state of a local user, included so a UI can prompt the user to change their password before it expires.

  • ACTIVE: The password is valid and not expired.
  • EXPIRED: The password has expired; the user must change it via POST /iam/change-password before continuing.
  • INVALID: Not applicable - the account's password isn't managed by Installer (for example, a remote LDAP user).
Enumeration: ACTIVE, EXPIRED, INVALID
EpochMsTimestamp
password_expiration_timestamp
Optional

Timestamp in milliseconds since epoch.

array of Role
roles
Optional

The roles currently assigned to this user or group.

Returned By