PUT /
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
Path parameters
Section titled “Path parameters”userstring Required
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Request body
Section titled “Request body”passwordstring Requiredmin length 1 · max length 1024
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.revoke_sessionsbooleandefault
true
Responses
Section titled “Responses”- 204 Set.
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
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"}'const response = await fetch("https://api.ohauthcat.com/v1/users/usr_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/password", { method: "PUT", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "password": "example_password" }),});const data = await response.json();import osimport requests
response = requests.put( "https://api.ohauthcat.com/v1/users/usr_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/password", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "password": "example_password", },)data = response.json()Response 204: no body.