GuidesRecipesAPI Reference
Log In
API Reference

đźš§ Perform an action on a user account (BETA)

đźš§

Under construction

This endpoint is in beta. Functionality may change without notice, support is limited, and use in production is not recommended. Your feedback is appreciated.

This endpoint will perform a credential action on a user account.

📌

Available actions

SEND_PASSWORD_RESET - Email the user a link to reset their own password
UNLOCK_ACCOUNT - Clear failed-login lockout state

Both actions are idempotent and require an organization-scoped credential.
Sending a password reset also activates the account if it was deactivated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

User ID.

Body Params

Available properties for sending a user a password reset email.

string
enum
required

Action to perform.

Allowed:
Headers
string

Specify API version, for example '1.0'. By default, the version configured in the company settings is used.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json