Skip to content
Dashboard
Theme
Theme

Set an end user's password

PUT /v1/users/{user}/password: Set an end user's password.

View Markdown

PUT /v1/users/{user}/password

Applies the environment’s password rules (length, account-details, history, character types and the breached-password check). By default it also signs the user out everywhere (revoke_sessions, D192). The password is never returned or logged.

Scope
users:write
Auth
Secret key (sk_…)
Since
1.0
  • user string Required

  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • password string Required

    min length 1 · max length 1024

  • revoke_sessions boolean

    Sign the user out everywhere (D192): end every hosted sign-in session of the user and delete the refresh tokens of its OAuth grants, in the same transaction, audited as user.signed_out with the counts. false keeps them signed in. Default true.

    default true

Errors share one shape; see the error code catalogue.

curl -X PUT \
"https://api.ohauthcat.com/v1/users/usr_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/password" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"password": "example_password"
}'

Response 204: no body.