Skip Navigation Links

Passwords

Check password configuration

Requires authentication via bearer.

Checks if a password is configured for a user.

Path Params

user_id stringrequired

Unique identifier of a user.

Query Params

embed string[]

Options for embedding additional data in password responses:

  • ACTIONS: Include available actions for the password (change, delete)

Response Body

200 OK

Reset password

Requires authentication via bearer.

Allows to set a new password for a user.

Path Params

user_id stringrequired

Unique identifier of a user.

Query Params

embed string[]

Options for embedding additional data in password responses:

  • ACTIONS: Include available actions for the password (change, delete)

Request Body

password stringrequired

The new password for the user. Must comply with the organization's password policy, which may include requirements for minimum length, character types, and password history.

temporary boolean

If true, the user will be required to change their password on next login. Recommended for admin-initiated password resets to ensure the user sets their own password.

Response Body

200 OK

Error Codes

  • PASSWORD_POLICY_NOT_RESPECTED
  • PASSWORD_HISTORY_POLICY_NOT_RESPECTED

Delete password

Requires authentication via bearer.

Allows to remove the password configured for a user. The user can no longer log-in via its credentials afterwards.'

Path Params

user_id stringrequired

Unique identifier of a user.

Query Params

embed string[]

Options for embedding additional data in password responses:

  • ACTIONS: Include available actions for the password (change, delete)

Response Body

200 OK

Request password reset link

Requires authentication via bearer.

Requests a password reset link for a user.

Path Params

user_id stringrequired

Unique identifier of a user.

Query Params

lifespan integer

Number of seconds after which the generated link expires (default is 86400 seconds, i.e. 24 hours).

Response Body

200 OK