--- title: "List each user's provisioning status, newest first" --- > Documentation Index > Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt > Use this file to discover all available pages before exploring further. Path: EZGH SSO API `GET /v1/organizations/{orgId}/sso/applications/{appId}/provisioning/users` ## Authentication Requires one of the following: - `apiKey`, http, header `Authorization` - `oauth`, http, header `Authorization` - `sessionCookie`, apiKey, in cookie ## Path parameters - `ListProvisionedUsers.path.orgId` (string, required) - format `uuid` - `ListProvisionedUsers.path.appId` (string, required) - format `uuid` ## Query parameters - `ListProvisionedUsers.query.limit` (integer, optional) — Page size, 1–100 (default 20). - min 1; max 100 - `ListProvisionedUsers.query.cursor` (string, optional) — The previous page's nextCursor. - `ListProvisionedUsers.query.status` (string, optional) — error: users whose last push failed. - one of `"active"`, `"inactive"`, `"none"`, `"error"` ## Code samples ### cURL ```curl curl --request GET \ --url https://sso.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/sso/applications/497f6eca-6276-4993-bfeb-53cbbbba6f08/provisioning/users \ --header 'Authorization: Bearer ' ``` ### TypeScript ```typescript const url = 'https://sso.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/sso/applications/497f6eca-6276-4993-bfeb-53cbbbba6f08/provisioning/users'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err)); ``` ### Python ```python import requests url = "https://sso.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/sso/applications/497f6eca-6276-4993-bfeb-53cbbbba6f08/provisioning/users" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.text) ``` ## Responses ### 200 A page of users. #### Example ```json { "nextCursor": "string", "users": [ { "createdByEzgh": true, "email": "string", "lastError": "string", "lastErrorAt": "2019-08-24T14:15:22Z", "lastPushedAt": "2019-08-24T14:15:22Z", "name": "string", "pending": true, "resourceName": "string", "scimId": "string", "state": "active", "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b" } ] } ``` - `ListProvisionedUsers.response.200.nextCursor` (string | null, required) - `ListProvisionedUsers.response.200.users` (array, required) - `ListProvisionedUsers.response.200.users.createdByEzgh` (boolean, required) — EZGH SSO created the user there; only those are repaired by reconcile. - `ListProvisionedUsers.response.200.users.email` (string, required) - `ListProvisionedUsers.response.200.users.lastError` (string | null, required) — The last failed push, as the application answered it; cleared by the next success. - `ListProvisionedUsers.response.200.users.lastErrorAt` (string | null, required) - format `date-time` - `ListProvisionedUsers.response.200.users.lastPushedAt` (string | null, required) - format `date-time` - `ListProvisionedUsers.response.200.users.name` (string, required) - `ListProvisionedUsers.response.200.users.pending` (boolean, required) — A push for the user is queued or being retried. - `ListProvisionedUsers.response.200.users.resourceName` (string, required) - `ListProvisionedUsers.response.200.users.scimId` (string | null, required) — The application's id for the user. - `ListProvisionedUsers.response.200.users.state` (string, required) — What was last pushed: active true, active false, or nothing there yet. - one of `"active"`, `"inactive"`, `"none"` - `ListProvisionedUsers.response.200.users.userId` (string, required) - format `uuid` ### 400 invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `ListProvisionedUsers.response.400.error` (object, required) - `ListProvisionedUsers.response.400.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `ListProvisionedUsers.response.400.error.message` (string, required) - maxLength 1024 - `ListProvisionedUsers.response.400.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `ListProvisionedUsers.response.400.error.issues.message` (string, required) - `ListProvisionedUsers.response.400.error.issues.path` (string, required) - `ListProvisionedUsers.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `ListProvisionedUsers.response.400.error.quota.id` (string, required) - `ListProvisionedUsers.response.400.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `ListProvisionedUsers.response.400.error.quota.limit` (integer, required) - min 0 - `ListProvisionedUsers.response.400.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `ListProvisionedUsers.response.400.error.quota.inFlight` (integer, optional) - min 0 - `ListProvisionedUsers.response.400.error.quota.periodStart` (string, optional) - format `date-time` - `ListProvisionedUsers.response.400.error.quota.region` (string, optional) - `ListProvisionedUsers.response.400.error.quota.resetsAt` (string, optional) - format `date-time` - `ListProvisionedUsers.response.400.error.quota.scopeResourceName` (string, optional) - `ListProvisionedUsers.response.400.error.quota.used` (integer, optional) - min 0 - `ListProvisionedUsers.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 401 unauthenticated: no credential, or one that doesn't check out. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `ListProvisionedUsers.response.401.error` (object, required) - `ListProvisionedUsers.response.401.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `ListProvisionedUsers.response.401.error.message` (string, required) - maxLength 1024 - `ListProvisionedUsers.response.401.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `ListProvisionedUsers.response.401.error.issues.message` (string, required) - `ListProvisionedUsers.response.401.error.issues.path` (string, required) - `ListProvisionedUsers.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `ListProvisionedUsers.response.401.error.quota.id` (string, required) - `ListProvisionedUsers.response.401.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `ListProvisionedUsers.response.401.error.quota.limit` (integer, required) - min 0 - `ListProvisionedUsers.response.401.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `ListProvisionedUsers.response.401.error.quota.inFlight` (integer, optional) - min 0 - `ListProvisionedUsers.response.401.error.quota.periodStart` (string, optional) - format `date-time` - `ListProvisionedUsers.response.401.error.quota.region` (string, optional) - `ListProvisionedUsers.response.401.error.quota.resetsAt` (string, optional) - format `date-time` - `ListProvisionedUsers.response.401.error.quota.scopeResourceName` (string, optional) - `ListProvisionedUsers.response.401.error.quota.used` (integer, optional) - min 0 - `ListProvisionedUsers.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 403 access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `ListProvisionedUsers.response.403.error` (object, required) - `ListProvisionedUsers.response.403.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `ListProvisionedUsers.response.403.error.message` (string, required) - maxLength 1024 - `ListProvisionedUsers.response.403.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `ListProvisionedUsers.response.403.error.issues.message` (string, required) - `ListProvisionedUsers.response.403.error.issues.path` (string, required) - `ListProvisionedUsers.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `ListProvisionedUsers.response.403.error.quota.id` (string, required) - `ListProvisionedUsers.response.403.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `ListProvisionedUsers.response.403.error.quota.limit` (integer, required) - min 0 - `ListProvisionedUsers.response.403.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `ListProvisionedUsers.response.403.error.quota.inFlight` (integer, optional) - min 0 - `ListProvisionedUsers.response.403.error.quota.periodStart` (string, optional) - format `date-time` - `ListProvisionedUsers.response.403.error.quota.region` (string, optional) - `ListProvisionedUsers.response.403.error.quota.resetsAt` (string, optional) - format `date-time` - `ListProvisionedUsers.response.403.error.quota.scopeResourceName` (string, optional) - `ListProvisionedUsers.response.403.error.quota.used` (integer, optional) - min 0 - `ListProvisionedUsers.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 404 not_found: unknown, malformed, or in an organization the caller isn't in. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `ListProvisionedUsers.response.404.error` (object, required) - `ListProvisionedUsers.response.404.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `ListProvisionedUsers.response.404.error.message` (string, required) - maxLength 1024 - `ListProvisionedUsers.response.404.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `ListProvisionedUsers.response.404.error.issues.message` (string, required) - `ListProvisionedUsers.response.404.error.issues.path` (string, required) - `ListProvisionedUsers.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `ListProvisionedUsers.response.404.error.quota.id` (string, required) - `ListProvisionedUsers.response.404.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `ListProvisionedUsers.response.404.error.quota.limit` (integer, required) - min 0 - `ListProvisionedUsers.response.404.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `ListProvisionedUsers.response.404.error.quota.inFlight` (integer, optional) - min 0 - `ListProvisionedUsers.response.404.error.quota.periodStart` (string, optional) - format `date-time` - `ListProvisionedUsers.response.404.error.quota.region` (string, optional) - `ListProvisionedUsers.response.404.error.quota.resetsAt` (string, optional) - format `date-time` - `ListProvisionedUsers.response.404.error.quota.scopeResourceName` (string, optional) - `ListProvisionedUsers.response.404.error.quota.used` (integer, optional) - min 0 - `ListProvisionedUsers.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 429 too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `ListProvisionedUsers.response.429.error` (object, required) - `ListProvisionedUsers.response.429.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `ListProvisionedUsers.response.429.error.message` (string, required) - maxLength 1024 - `ListProvisionedUsers.response.429.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `ListProvisionedUsers.response.429.error.issues.message` (string, required) - `ListProvisionedUsers.response.429.error.issues.path` (string, required) - `ListProvisionedUsers.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `ListProvisionedUsers.response.429.error.quota.id` (string, required) - `ListProvisionedUsers.response.429.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `ListProvisionedUsers.response.429.error.quota.limit` (integer, required) - min 0 - `ListProvisionedUsers.response.429.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `ListProvisionedUsers.response.429.error.quota.inFlight` (integer, optional) - min 0 - `ListProvisionedUsers.response.429.error.quota.periodStart` (string, optional) - format `date-time` - `ListProvisionedUsers.response.429.error.quota.region` (string, optional) - `ListProvisionedUsers.response.429.error.quota.resetsAt` (string, optional) - format `date-time` - `ListProvisionedUsers.response.429.error.quota.scopeResourceName` (string, optional) - `ListProvisionedUsers.response.429.error.quota.used` (integer, optional) - min 0 - `ListProvisionedUsers.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 500 internal_error: a bug; the details are in the logs, under the request ID. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `ListProvisionedUsers.response.500.error` (object, required) - `ListProvisionedUsers.response.500.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `ListProvisionedUsers.response.500.error.message` (string, required) - maxLength 1024 - `ListProvisionedUsers.response.500.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `ListProvisionedUsers.response.500.error.issues.message` (string, required) - `ListProvisionedUsers.response.500.error.issues.path` (string, required) - `ListProvisionedUsers.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `ListProvisionedUsers.response.500.error.quota.id` (string, required) - `ListProvisionedUsers.response.500.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `ListProvisionedUsers.response.500.error.quota.limit` (integer, required) - min 0 - `ListProvisionedUsers.response.500.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `ListProvisionedUsers.response.500.error.quota.inFlight` (integer, optional) - min 0 - `ListProvisionedUsers.response.500.error.quota.periodStart` (string, optional) - format `date-time` - `ListProvisionedUsers.response.500.error.quota.region` (string, optional) - `ListProvisionedUsers.response.500.error.quota.resetsAt` (string, optional) - format `date-time` - `ListProvisionedUsers.response.500.error.quota.scopeResourceName` (string, optional) - `ListProvisionedUsers.response.500.error.quota.used` (integer, optional) - min 0 - `ListProvisionedUsers.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. ### 503 unavailable: a dependency the request needs is down. Retry after Retry-After. #### Example ```json { "error": { "code": "string", "issues": [ { "message": "string", "path": "string" } ], "message": "string", "quota": { "id": "string", "inFlight": 0, "kind": "allocation", "limit": 0, "periodStart": "2019-08-24T14:15:22Z", "region": "string", "resetsAt": "2019-08-24T14:15:22Z", "scope": "organization", "scopeResourceName": "string", "used": 0, "window": "string" } } } ``` - `ListProvisionedUsers.response.503.error` (object, required) - `ListProvisionedUsers.response.503.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `ListProvisionedUsers.response.503.error.message` (string, required) - maxLength 1024 - `ListProvisionedUsers.response.503.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `ListProvisionedUsers.response.503.error.issues.message` (string, required) - `ListProvisionedUsers.response.503.error.issues.path` (string, required) - `ListProvisionedUsers.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `ListProvisionedUsers.response.503.error.quota.id` (string, required) - `ListProvisionedUsers.response.503.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `ListProvisionedUsers.response.503.error.quota.limit` (integer, required) - min 0 - `ListProvisionedUsers.response.503.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `ListProvisionedUsers.response.503.error.quota.inFlight` (integer, optional) - min 0 - `ListProvisionedUsers.response.503.error.quota.periodStart` (string, optional) - format `date-time` - `ListProvisionedUsers.response.503.error.quota.region` (string, optional) - `ListProvisionedUsers.response.503.error.quota.resetsAt` (string, optional) - format `date-time` - `ListProvisionedUsers.response.503.error.quota.scopeResourceName` (string, optional) - `ListProvisionedUsers.response.503.error.quota.used` (integer, optional) - min 0 - `ListProvisionedUsers.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. Source: https://docs.ezghcloud.com/sso-api/ListProvisionedUsers/index.md