Developers
Users38

List product access

GET/users/{user_id}/products

Returns the user's effective access to each product, using cursor-based pagination and sorted by product ID.

If the current credentials are restricted to specific products, only those products are included.

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_.

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "product_id"
  • "-product_id"

Header Parameters

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/users/string/products"
{  "data": [    {      "denial_reason": "no_access",      "ends_at": "2019-08-24T14:15:22Z",      "has_access": true,      "object": "product_access",      "overrides": {        "duration": {          "type": "-1",          "value": 0        },        "rules_waived": true,        "schedule_id": "string"      },      "product_id": "string",      "revision": "string",      "sources": [        {          "enrollment_id": "string",          "kind": "manual"        }      ],      "starts_at": "2019-08-24T14:15:22Z",      "user_id": "string"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Send a password reset email POST

Sends the user an email with a link to reset their password. A password reset email can be sent to the same user at most once every 10 minutes. Earlier attempts return `email_recently_sent`.

Retrieve product access GET

Retrieves the user's effective access to a product, including the sources that grant it (`sources[]`), the reason access is denied when applicable (`denial_reason`), and any overrides applied to the user (`overrides`). The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the product access to avoid overwriting a newer version.