users
Add a user
Creates a new user account in the system and returns the new user's details. Supply the required user properties as query parameters.
Add a user
Creates a new user account in the system and returns the new user's details. Supply the required user properties in the request body.
Query user two-factor status
Queries the two-factor authentication (2FA) status for a user as a pre-authentication step. This call counts as a sign-in attempt, so repeated failures may trigger account lockout policies.
Elevate user two-factor status
Elevates the two-factor authentication (2FA) status for a user after they have already authenticated. This post-authentication step counts as a sign-in attempt and returns an updated authentication response on success.
Validates a user password
Validates the supplied password for the specified user. Returns 204 No Content on success; use this endpoint to verify password correctness without performing a full authentication.
Validates a user password
Submits a user password in the request body for validation. Returns 204 No Content on success, indicating the password is correct for the specified user.
Delete a user
Permanently deletes the specified user account from the system. Returns 204 No Content on success. This action cannot be undone.
Delete a user
Submits a request to permanently delete the specified user account from the system. Returns 204 No Content on success. This action cannot be undone.
Get a user's details
Returns the full details for the specified user account. Use this endpoint to retrieve profile and configuration information for a given username.
Get a user's details
Submits a request to retrieve the full details for the specified user account. Returns profile and configuration information for the given username.
Update stored user details
Updates the stored details for the specified user account. UserManage permissions are required to modify any user account other than the caller's own.
Update stored user details
Submits updated details for the specified user account in the request body. UserManage permissions are required to modify any user account other than the caller's own.
Update user password
Updates the stored password for the specified user. The CurrentPassword field must contain the password of the user making the request. UserManage permissions are required to change the password of any user other than the caller.
Update user password
Submits a password update request in the request body. The CurrentPassword field must contain the password of the user making the request. UserManage permissions are required to change the password of any user other than the caller.
Reset user
Resets the specified user account to a default state. UserManage permissions are required to reset any user account other than the caller's own.
Reset user
Submits a request to reset the specified user account to a default state. UserManage permissions are required to reset any user account other than the caller's own.
Reset user password
Resets the password for the specified user and returns the new temporary password in the response. This operation is intended for administrators managing other users and requires UserManage permissions.
Reset user password
Submits a request to reset the password for the specified user and returns the new temporary password in the response. This operation is intended for administrators managing other users and requires UserManage permissions.
Generate preview reset password
Generates a preview of the reset password without applying the change. Returns a PreviewToken that you can pass to the resetPassword endpoint to commit the password reset when ready.
Reset user 2FA
Resets the two-factor authentication (2FA) configuration for the specified user, requiring them to re-enroll. UserManage permissions are required to reset 2FA for any user other than the caller.
Reset user 2FA
Submits a request to reset the two-factor authentication (2FA) configuration for the specified user. UserManage permissions are required to reset 2FA for any user other than the caller.
Get a list of user names
Returns a list of all user accounts in the system, including their details. Use this endpoint to enumerate users for administrative or reporting purposes.
Get a list of user names
Submits a request to retrieve all user accounts and their details. Returns a list of UserDetails objects.