v1

latestOpenAPI 3.0.32026-08-0631918.6 KB

Authenticate password

Authenticates a user using their username and password. The value of this username may correspond to the user's username, phone number, or email (based on what was used to register their password credentials).

post/v1/auth/password/authenticate

Request body

resourcestring

Resource URI the authentication request is attempting to access, which is reflected in the audience (aud claim) of the access token. This must be configured as resource for the application.

claimsobject

Used to request additional claims in the ID token, such as roles, permissions, and other user profile data. The structure is per the OIDC Standard. For supported claims and how to request custom claims, see the ID Token Reference.

org_idstring

Organization ID, used for member login in B2B scenarios

session_idstring

Used to associate the authentication with an existing session (such as for MFA). If unspecified, a new session is created and the session ID is returned.

usernamestring required

Identifier of the user, which may contain the user's username, email or phone number (depending on what was used to register password credentials). The username_type must match the type of identifier used.

passwordstring required

Password

username_type'username' | 'email' | 'phone_number'

Type of user identifier used to register the password

Example request

{
  "username": "<ADD USERNAME HERE>",
  "password": "MyPassword123$",
  "username_type": "username"
}

Response

Returns user tokens

access_tokenstring required

User access token for accessing endpoints on behalf of the authenticated user.

id_tokenstring

ID token that identifies the user.

refresh_tokenstring

Refresh token used to refresh an expired access token.

token_typestring required

Bearer.

expires_innumber required

Expiration time of the access token in seconds.

session_idstring required

ID of the session in which the authentication occurs.