curl --request POST \
--url https://api.example.com/v1/auth/login \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"password": "<string>",
"web": true,
"idpName": "<string>",
"idpContext": {
"oauth2Context": {
"code": "<string>"
},
"oidcContext": {
"code": "<string>"
}
},
"otpCode": "<string>",
"recoveryCode": "<string>",
"mfaTempToken": "<string>"
}
'{
"token": "<string>",
"mfaTempToken": "<string>",
"requireResetPassword": true,
"user": {
"name": "<string>",
"state": "STATE_UNSPECIFIED",
"email": "<string>",
"title": "<string>",
"userType": "USER_TYPE_UNSPECIFIED",
"mfaEnabled": true,
"tempOtpSecret": "<string>",
"tempRecoveryCodes": [
"<string>"
],
"tempOtpSecretCreatedTime": "2023-11-07T05:31:56Z",
"phone": "<string>",
"profile": {
"lastLoginTime": "2023-11-07T05:31:56Z",
"lastChangePasswordTime": "2023-11-07T05:31:56Z",
"source": "<string>"
},
"groups": [
"<string>"
],
"workloadIdentityConfig": {
"providerType": "PROVIDER_TYPE_UNSPECIFIED",
"issuerUrl": "<string>",
"allowedAudiences": [
"<string>"
],
"subjectPattern": "<string>"
}
}
}Authenticates a user and returns access tokens. Permissions required: None
curl --request POST \
--url https://api.example.com/v1/auth/login \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"password": "<string>",
"web": true,
"idpName": "<string>",
"idpContext": {
"oauth2Context": {
"code": "<string>"
},
"oidcContext": {
"code": "<string>"
}
},
"otpCode": "<string>",
"recoveryCode": "<string>",
"mfaTempToken": "<string>"
}
'{
"token": "<string>",
"mfaTempToken": "<string>",
"requireResetPassword": true,
"user": {
"name": "<string>",
"state": "STATE_UNSPECIFIED",
"email": "<string>",
"title": "<string>",
"userType": "USER_TYPE_UNSPECIFIED",
"mfaEnabled": true,
"tempOtpSecret": "<string>",
"tempRecoveryCodes": [
"<string>"
],
"tempOtpSecretCreatedTime": "2023-11-07T05:31:56Z",
"phone": "<string>",
"profile": {
"lastLoginTime": "2023-11-07T05:31:56Z",
"lastChangePasswordTime": "2023-11-07T05:31:56Z",
"source": "<string>"
},
"groups": [
"<string>"
],
"workloadIdentityConfig": {
"providerType": "PROVIDER_TYPE_UNSPECIFIED",
"issuerUrl": "<string>",
"allowedAudiences": [
"<string>"
],
"subjectPattern": "<string>"
}
}
}User's email address.
User's password for authentication.
If web is set, we will set access token, refresh token, and user to the cookie.
The name of the identity provider. Format: idps/{idp}
The idp_context is using to get the user information from identity provider.
Show child attributes
The otp_code is used to verify the user's identity by MFA.
The recovery_code is used to recovery the user's identity with MFA.
The mfa_temp_token is used to verify the user's identity by MFA.
Was this page helpful?