LoginRequest

Login request

Credentials submitted to POST /iam/login to start an authenticated session.

JSON Example

{
    "user_name": "string",
    "password": "string",
    "user_type": "string"
}

string

user_name

Required

The user name to authenticate. For LDAP users, this may need to include the domain, depending on how the identity source is configured.

string

password

Required

The password for user_name. Not returned in any response.

UserType

user_type

Required

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

Parameter To

Login