Users

Reset a user's password

Sets a new password for the user (≥4 chars), signing them out of every device. Returns the credentials to share (no email in v1).

POST
/users/{id}/reset-password

Sets a new password for the user (≥4 chars), signing them out of every device. Returns the credentials to share (no email in v1).

Authorization

x-api-key<token>

The per-tenant API key, copied from Settings → API & integrations. Sent as the x-api-key request header. The key is tenant-scoped and acts with Admin-equivalent, tenant-wide access.

In: header

Path Parameters

id*string

Resource id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/reset-password" \  -H "Content-Type: application/json" \  -d '{    "password": "string"  }'
{  "credentials": {    "email": "user@example.com",    "password": "string"  }}
{  "error": {    "code": "unauthorized",    "message": "Missing or invalid API key."  }}
{  "error": {    "code": "read_only",    "message": "Your subscription is inactive. This action is read-only."  }}
{  "error": {    "code": "not_found",    "message": "Not found."  }}
{  "error": {    "code": "validation",    "message": "One or more inputs are invalid.",    "fields": {      "fieldName": "A message explaining what's wrong with this field."    }  }}

Reinstate a revoked user POST

Restores a revoked user's login (existing password) and their preserved project assignments. Blocked with `409` if their email is now used by another active user.

Revoke a user's access POST

Revokes the user — blocks login, kills active sessions, and hides them from pickers. The row is kept (reinstate restores it). Revoking yourself is forbidden.