--- title: "Get an application's outbound SCIM provisioning" description: "Settings (never the bearer token) and status, with the settings' ETag. An ezgh application isn't provisioned (409 provisioning_not_supported)." --- > 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` Settings (never the bearer token) and status, with the settings' ETag. An ezgh application isn't provisioned (409 provisioning_not_supported). ## Authentication Requires one of the following: - `apiKey`, http, header `Authorization` - `oauth`, http, header `Authorization` - `sessionCookie`, apiKey, in cookie ## Path parameters - `GetProvisioning.path.orgId` (string, required) - format `uuid` - `GetProvisioning.path.appId` (string, required) - format `uuid` ## 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 \ --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'; 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" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.text) ``` ## Responses ### 200 The provisioning settings and status. #### Example ```json { "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5", "attributeMappings": [ { "source": "string", "target": "string" } ], "baseUrl": "http://example.com", "bearerTokenSet": true, "configured": true, "createdAt": "2019-08-24T14:15:22Z", "enabled": true, "hardDelete": true, "pushGroups": true, "status": { "groups": { "errors": 0, "pushed": 0 }, "lastError": "string", "lastErrorAt": "2019-08-24T14:15:22Z", "lastReconcileAt": "2019-08-24T14:15:22Z", "lastReconcileError": "string", "lastSuccessAt": "2019-08-24T14:15:22Z", "nextReconcileAt": "2019-08-24T14:15:22Z", "pausedUntil": "2019-08-24T14:15:22Z", "pendingJobs": 0, "reconcileRequestedAt": "2019-08-24T14:15:22Z", "state": "notConfigured", "users": { "active": 0, "errors": 0, "inactive": 0 } }, "updatedAt": "2019-08-24T14:15:22Z" } ``` - `GetProvisioning.response.200.applicationId` (string, required) - format `uuid` - `GetProvisioning.response.200.attributeMappings` (array, required) - `GetProvisioning.response.200.attributeMappings.source` (string, required) - minLength 1; maxLength 512 - `GetProvisioning.response.200.attributeMappings.target` (string, required) - maxLength 320 - `GetProvisioning.response.200.baseUrl` (string | null, required) — The application's SCIM 2.0 base URL (https, a public host). Every request goes through EZGH SSO's hardened egress. - format `uri` - `GetProvisioning.response.200.bearerTokenSet` (boolean, required) — Whether a bearer token is stored. The token is never returned. - `GetProvisioning.response.200.configured` (boolean, required) — false until the first PUT; the other fields then show the defaults. - `GetProvisioning.response.200.createdAt` (string | null, required) - format `date-time` - `GetProvisioning.response.200.enabled` (boolean, required) - `GetProvisioning.response.200.hardDelete` (boolean, required) — Send DELETE when a directory user is deleted. Unassigning or suspending always sends active: false. - `GetProvisioning.response.200.pushGroups` (boolean, required) — Push the groups assigned to the application, with their provisioned members. - `GetProvisioning.response.200.status` (object, required) - `GetProvisioning.response.200.status.groups` (object, required) - `GetProvisioning.response.200.status.groups.errors` (integer, required) - min 0 - `GetProvisioning.response.200.status.groups.pushed` (integer, required) - min 0 - `GetProvisioning.response.200.status.lastError` (string | null, required) — The most recent failed push or reconcile, as the application answered it. - `GetProvisioning.response.200.status.lastErrorAt` (string | null, required) - format `date-time` - `GetProvisioning.response.200.status.lastReconcileAt` (string | null, required) - format `date-time` - `GetProvisioning.response.200.status.lastReconcileError` (string | null, required) - `GetProvisioning.response.200.status.lastSuccessAt` (string | null, required) - format `date-time` - `GetProvisioning.response.200.status.nextReconcileAt` (string | null, required) - format `date-time` - `GetProvisioning.response.200.status.pausedUntil` (string | null, required) - format `date-time` - `GetProvisioning.response.200.status.pendingJobs` (integer, required) - min 0 - `GetProvisioning.response.200.status.reconcileRequestedAt` (string | null, required) - format `date-time` - `GetProvisioning.response.200.status.state` (string, required) — paused: the application answered 429 and pushes wait for its Retry-After; syncing: jobs are pending; error: some user's or group's last push failed. - one of `"notConfigured"`, `"disabled"`, `"paused"`, `"syncing"`, `"error"`, `"idle"` - `GetProvisioning.response.200.status.users` (object, required) - `GetProvisioning.response.200.status.users.active` (integer, required) - min 0 - `GetProvisioning.response.200.status.users.errors` (integer, required) - min 0 - `GetProvisioning.response.200.status.users.inactive` (integer, required) - min 0 - `GetProvisioning.response.200.updatedAt` (string | null, required) - format `date-time` ### 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" } } } ``` - `GetProvisioning.response.400.error` (object, required) - `GetProvisioning.response.400.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetProvisioning.response.400.error.message` (string, required) - maxLength 1024 - `GetProvisioning.response.400.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetProvisioning.response.400.error.issues.message` (string, required) - `GetProvisioning.response.400.error.issues.path` (string, required) - `GetProvisioning.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetProvisioning.response.400.error.quota.id` (string, required) - `GetProvisioning.response.400.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetProvisioning.response.400.error.quota.limit` (integer, required) - min 0 - `GetProvisioning.response.400.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetProvisioning.response.400.error.quota.inFlight` (integer, optional) - min 0 - `GetProvisioning.response.400.error.quota.periodStart` (string, optional) - format `date-time` - `GetProvisioning.response.400.error.quota.region` (string, optional) - `GetProvisioning.response.400.error.quota.resetsAt` (string, optional) - format `date-time` - `GetProvisioning.response.400.error.quota.scopeResourceName` (string, optional) - `GetProvisioning.response.400.error.quota.used` (integer, optional) - min 0 - `GetProvisioning.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" } } } ``` - `GetProvisioning.response.401.error` (object, required) - `GetProvisioning.response.401.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetProvisioning.response.401.error.message` (string, required) - maxLength 1024 - `GetProvisioning.response.401.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetProvisioning.response.401.error.issues.message` (string, required) - `GetProvisioning.response.401.error.issues.path` (string, required) - `GetProvisioning.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetProvisioning.response.401.error.quota.id` (string, required) - `GetProvisioning.response.401.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetProvisioning.response.401.error.quota.limit` (integer, required) - min 0 - `GetProvisioning.response.401.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetProvisioning.response.401.error.quota.inFlight` (integer, optional) - min 0 - `GetProvisioning.response.401.error.quota.periodStart` (string, optional) - format `date-time` - `GetProvisioning.response.401.error.quota.region` (string, optional) - `GetProvisioning.response.401.error.quota.resetsAt` (string, optional) - format `date-time` - `GetProvisioning.response.401.error.quota.scopeResourceName` (string, optional) - `GetProvisioning.response.401.error.quota.used` (integer, optional) - min 0 - `GetProvisioning.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" } } } ``` - `GetProvisioning.response.403.error` (object, required) - `GetProvisioning.response.403.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetProvisioning.response.403.error.message` (string, required) - maxLength 1024 - `GetProvisioning.response.403.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetProvisioning.response.403.error.issues.message` (string, required) - `GetProvisioning.response.403.error.issues.path` (string, required) - `GetProvisioning.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetProvisioning.response.403.error.quota.id` (string, required) - `GetProvisioning.response.403.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetProvisioning.response.403.error.quota.limit` (integer, required) - min 0 - `GetProvisioning.response.403.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetProvisioning.response.403.error.quota.inFlight` (integer, optional) - min 0 - `GetProvisioning.response.403.error.quota.periodStart` (string, optional) - format `date-time` - `GetProvisioning.response.403.error.quota.region` (string, optional) - `GetProvisioning.response.403.error.quota.resetsAt` (string, optional) - format `date-time` - `GetProvisioning.response.403.error.quota.scopeResourceName` (string, optional) - `GetProvisioning.response.403.error.quota.used` (integer, optional) - min 0 - `GetProvisioning.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" } } } ``` - `GetProvisioning.response.404.error` (object, required) - `GetProvisioning.response.404.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetProvisioning.response.404.error.message` (string, required) - maxLength 1024 - `GetProvisioning.response.404.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetProvisioning.response.404.error.issues.message` (string, required) - `GetProvisioning.response.404.error.issues.path` (string, required) - `GetProvisioning.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetProvisioning.response.404.error.quota.id` (string, required) - `GetProvisioning.response.404.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetProvisioning.response.404.error.quota.limit` (integer, required) - min 0 - `GetProvisioning.response.404.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetProvisioning.response.404.error.quota.inFlight` (integer, optional) - min 0 - `GetProvisioning.response.404.error.quota.periodStart` (string, optional) - format `date-time` - `GetProvisioning.response.404.error.quota.region` (string, optional) - `GetProvisioning.response.404.error.quota.resetsAt` (string, optional) - format `date-time` - `GetProvisioning.response.404.error.quota.scopeResourceName` (string, optional) - `GetProvisioning.response.404.error.quota.used` (integer, optional) - min 0 - `GetProvisioning.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" } } } ``` - `GetProvisioning.response.429.error` (object, required) - `GetProvisioning.response.429.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetProvisioning.response.429.error.message` (string, required) - maxLength 1024 - `GetProvisioning.response.429.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetProvisioning.response.429.error.issues.message` (string, required) - `GetProvisioning.response.429.error.issues.path` (string, required) - `GetProvisioning.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetProvisioning.response.429.error.quota.id` (string, required) - `GetProvisioning.response.429.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetProvisioning.response.429.error.quota.limit` (integer, required) - min 0 - `GetProvisioning.response.429.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetProvisioning.response.429.error.quota.inFlight` (integer, optional) - min 0 - `GetProvisioning.response.429.error.quota.periodStart` (string, optional) - format `date-time` - `GetProvisioning.response.429.error.quota.region` (string, optional) - `GetProvisioning.response.429.error.quota.resetsAt` (string, optional) - format `date-time` - `GetProvisioning.response.429.error.quota.scopeResourceName` (string, optional) - `GetProvisioning.response.429.error.quota.used` (integer, optional) - min 0 - `GetProvisioning.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" } } } ``` - `GetProvisioning.response.500.error` (object, required) - `GetProvisioning.response.500.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetProvisioning.response.500.error.message` (string, required) - maxLength 1024 - `GetProvisioning.response.500.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetProvisioning.response.500.error.issues.message` (string, required) - `GetProvisioning.response.500.error.issues.path` (string, required) - `GetProvisioning.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetProvisioning.response.500.error.quota.id` (string, required) - `GetProvisioning.response.500.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetProvisioning.response.500.error.quota.limit` (integer, required) - min 0 - `GetProvisioning.response.500.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetProvisioning.response.500.error.quota.inFlight` (integer, optional) - min 0 - `GetProvisioning.response.500.error.quota.periodStart` (string, optional) - format `date-time` - `GetProvisioning.response.500.error.quota.region` (string, optional) - `GetProvisioning.response.500.error.quota.resetsAt` (string, optional) - format `date-time` - `GetProvisioning.response.500.error.quota.scopeResourceName` (string, optional) - `GetProvisioning.response.500.error.quota.used` (integer, optional) - min 0 - `GetProvisioning.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" } } } ``` - `GetProvisioning.response.503.error` (object, required) - `GetProvisioning.response.503.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `GetProvisioning.response.503.error.message` (string, required) - maxLength 1024 - `GetProvisioning.response.503.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `GetProvisioning.response.503.error.issues.message` (string, required) - `GetProvisioning.response.503.error.issues.path` (string, required) - `GetProvisioning.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `GetProvisioning.response.503.error.quota.id` (string, required) - `GetProvisioning.response.503.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `GetProvisioning.response.503.error.quota.limit` (integer, required) - min 0 - `GetProvisioning.response.503.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `GetProvisioning.response.503.error.quota.inFlight` (integer, optional) - min 0 - `GetProvisioning.response.503.error.quota.periodStart` (string, optional) - format `date-time` - `GetProvisioning.response.503.error.quota.region` (string, optional) - `GetProvisioning.response.503.error.quota.resetsAt` (string, optional) - format `date-time` - `GetProvisioning.response.503.error.quota.scopeResourceName` (string, optional) - `GetProvisioning.response.503.error.quota.used` (integer, optional) - min 0 - `GetProvisioning.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. Source: https://docs.ezghcloud.com/sso-api/GetProvisioning/index.md