Log in

Logs in the user and creates an active session

Authentication

Authorizationstring
API key needed to access this API
OR
AuthorizationBearer
API key needed to access this API, in Bearer token format

Request

loginSchema
usernamestringRequired
The username trying to log in
passwordstringRequired
The password of the user trying to log in

Response

userSchema
idinteger
The user id
namestring or null
Name of the user
emailstring or null
Email of the user
usernamestring or null
A unique username for the user
imageUrlstring or null
URL used for the user profile image
loginAttemptsinteger or null>=0
How many unsuccessful attempts at logging in has the user made
emailSentboolean or null
Is the welcome email sent to the user or not
rootRoleinteger or null>=0

Which root role this user is assigned

seenAtstring or nullformat: "date-time"
The last time this user logged in
createdAtstring or nullformat: "date-time"
The user was created at this time
accountTypeenum or null
A user is either an actual User or a Service Account
Allowed values:
permissionslist of strings or null
Deprecated
scimIdstring or null
The SCIM ID of the user, only present if managed by SCIM
seatTypestring or null
The seat type of this user
activeSessionsinteger or null
Count of active browser sessions for this user
deletedSessionsdouble or null
Experimental. The number of deleted browser sessions after last login

Errors