LoginAuthResponse

Login Auth Response

The authenticated user's identity and roles, returned on a successful POST /iam/login.

JSON Example

{
    "user_name": "string",
    "display_name": "string",
    "user_type": "string",
    "roles": [
        {
            "role": "string",
            "display_name": "string"
        }
    ]
}

string

user_name

Optional

The user name that was authenticated.

string

display_name

Optional

The human-readable name for this user, 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

array of Role

roles

Optional

The roles held by this user, which determine which Installer APIs the current session is authorized to call.

Returned By

Login