Skip to main content
POST
/
v1
/
auth
/
login
{
  "token": "<string>",
  "mfaTempToken": "<string>",
  "requireResetPassword": true,
  "user": {
    "name": "<string>",
    "state": "STATE_UNSPECIFIED",
    "email": "<string>",
    "title": "<string>",
    "userType": "USER_TYPE_UNSPECIFIED",
    "mfaEnabled": true,
    "mfaSecret": "<string>",
    "recoveryCodes": [
      "<string>"
    ],
    "phone": "<string>",
    "profile": {
      "lastLoginTime": "2023-11-07T05:31:56Z",
      "lastChangePasswordTime": "2023-11-07T05:31:56Z",
      "source": "<string>"
    },
    "groups": [
      "<string>"
    ]
  }
}

Body

application/json
​
email
string

User's email address.

​
password
string

User's password for authentication.

​
web
boolean

If web is set, we will set access token, refresh token, and user to the cookie.

​
idpName
string

The name of the identity provider. Format: idps/{idp}

​
idpContext
object

The idp_context is using to get the user information from identity provider. Context for identity provider authentication.

​
otpCode
string

The otp_code is used to verify the user's identity by MFA.

​
recoveryCode
string

The recovery_code is used to recovery the user's identity with MFA.

​
mfaTempToken
string

The mfa_temp_token is used to verify the user's identity by MFA.

Response

OK

​
token
string

Access token for authenticated requests.

​
mfaTempToken
string

Temporary token for MFA verification.

​
requireResetPassword
boolean

Whether user must reset password before continuing.

​
user
object

The user from the successful login.