Developers
Users38

Update access duration for all products

PATCH/users/{user_id}/access

Applies the same access duration to every product the user has access to.

The request is processed asynchronously. The response returns an operation, and the Location header points to it so you can track its progress.

An Idempotency-Key header is required.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

user_id*string

Public ID of the user, prefixed with usr_.

Header Parameters

Idempotency-Key*string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. Repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

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

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/users/string/access" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "duration": {      "type": "string"    }  }'
{  "data": {    "attempt": {      "number": 0,      "status": "running"    },    "cancellation_requested": true,    "created_at": "2019-08-24T14:15:22Z",    "error": {      "code": "worker_error",      "field": "string",      "message": "string",      "reason": "string",      "resource_id": "string"    },    "expires_at": "2019-08-24T14:15:22Z",    "finished_at": "2019-08-24T14:15:22Z",    "id": "string",    "items_url": "string",    "object": "operation",    "progress": {      "done": 0,      "failed": 0,      "total": 0    },    "result_url": "string",    "started_at": "2019-08-24T14:15:22Z",    "status": "queued",    "type": "string"  }}

Delete a user DELETE

Moves the user to the trash. The user's enrollments, access, and associations are preserved. To restore the user, send `deleted: false` to the update operation.

Send an access email POST

Generates a new password for the user and emails the access credentials. The user's previous password stops working. An access email can be sent to the same user at most once every 10 minutes. Earlier attempts return `email_recently_sent`.