Skip to main content

SCIM

GET/v1/orgs/{org_id}/scim/v2/Users

List Users

List users (SCIM GET /Users with pagination and filter).

SCIM bearer tokenscope: scim provisioningoperation_id: scim.listUsers

Authentication

Send Authorization: Bearer <scim-token>. Mint it via POST /v1/orgs/{org_id}/scim/token (admin only) and store it with your IdP, so the integration can be revoked on its own.

SDK install

pip install znyx-sdknpm install @znyx/sdk

Code samples

Request

curl -X GET "$ZNYX_API_URL/v1/orgs/00000000-0000-0000-0000-000000000000/scim/v2/Users?startIndex=1&count=100" \
  -H "Authorization: Bearer $ZNYX_TOKEN"

Response

application/json

Successful Response

null

Schema: any

Path parameters

NameTypeRequiredDescription
org_id#pathstringrequired-

Query parameters

NameTypeRequiredDescription
startIndex#queryintegeroptional-
count#queryintegeroptional-
filter#querystring | nulloptional-

Header parameters

NameTypeRequiredDescription
authorization#headerstring | nulloptional-

Responses

StatusDescription
200Successful Response
422Validation Error

Response schema

any

Errors & what triggers them

CodeTriggerFix
401Missing or expired Authorization header.-
403Token does not have org access (wrong org_id, or insufficient role).-
404Resource does not exist in this org.-