--- title: "List the directory's identity providers, 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/identity-providers` ## Authentication Requires one of the following: - `apiKey`, http, header `Authorization` - `oauth`, http, header `Authorization` - `sessionCookie`, apiKey, in cookie ## Path parameters - `ListIdentityProviders.path.orgId` (string, required) - format `uuid` ## Query parameters - `ListIdentityProviders.query.limit` (integer, optional) — Page size, 1–100 (default 20). - min 1; max 100 - `ListIdentityProviders.query.cursor` (string, optional) — The previous page's nextCursor. - `ListIdentityProviders.query.protocol` (string, optional) - one of `"oidc"`, `"saml"` ## Code samples ### cURL ```curl curl --request GET \ --url https://sso.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/sso/identity-providers \ --header 'Authorization: Bearer ' ``` ### TypeScript ```typescript const url = 'https://sso.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/sso/identity-providers'; 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/identity-providers" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.text) ``` ## Responses ### 200 A page of identity providers. #### Example ```json { "identityProviders": [ { "createdAt": "2019-08-24T14:15:22Z", "description": "string", "directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18", "domains": [ "string" ], "groupMappings": [ { "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55", "idpGroup": "string" } ], "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "metadata": { "error": "string", "fetchedAt": "2019-08-24T14:15:22Z", "refreshRequestedAt": "2019-08-24T14:15:22Z" }, "name": "string", "oidc": { "clientId": "string", "clientSecretSet": true, "customDomainRedirectUris": [ "http://example.com" ], "discovery": { "authorizationEndpoint": "string", "idTokenSigningAlgs": [ "string" ], "issuer": "string", "jwksUri": "string", "tokenEndpoint": "string" }, "emailClaim": "string", "groupsClaim": "string", "issuer": "http://example.com", "redirectUri": "http://example.com", "scopes": [ "string" ], "tokenEndpointAuthMethod": "client_secret_basic" }, "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "projectId": "string", "protocol": "oidc", "provisioning": { "jit": true, "scim": true }, "region": "string", "resourceName": "string", "saml": { "emailAttribute": "string", "groupsAttribute": "string", "identityProvider": { "certificates": [ { "notAfter": "2019-08-24T14:15:22Z", "sha256": "string", "subject": "string" } ], "entityId": "string", "ssoUrl": "string" }, "metadataUrl": "http://example.com", "serviceProvider": { "acsUrl": "string", "customDomainAcsUrls": [ "http://example.com" ], "entityId": "string", "metadataUrl": "string" } }, "slug": "string", "status": "string", "tags": { "property1": "string", "property2": "string" }, "updatedAt": "2019-08-24T14:15:22Z" } ], "nextCursor": "string" } ``` - `ListIdentityProviders.response.200.identityProviders` (array, required) - `ListIdentityProviders.response.200.identityProviders.createdAt` (string, required) - format `date-time` - `ListIdentityProviders.response.200.identityProviders.description` (string, required) - `ListIdentityProviders.response.200.identityProviders.directoryId` (string, required) - format `uuid` - `ListIdentityProviders.response.200.identityProviders.domains` (array, required) — The directory's domains routed here; each routes only while verified. - `ListIdentityProviders.response.200.identityProviders.groupMappings` (array, required) - `ListIdentityProviders.response.200.identityProviders.groupMappings.groupId` (string, required) — A hosted directory group. - format `uuid` - `ListIdentityProviders.response.200.identityProviders.groupMappings.idpGroup` (string, required) — The group's name at the identity provider, or * for everyone who signs in through it. - `ListIdentityProviders.response.200.identityProviders.id` (string, required) - format `uuid` - `ListIdentityProviders.response.200.identityProviders.metadata` (object, required) - `ListIdentityProviders.response.200.identityProviders.metadata.error` (string | null, required) - `ListIdentityProviders.response.200.identityProviders.metadata.fetchedAt` (string | null, required) - format `date-time` - `ListIdentityProviders.response.200.identityProviders.metadata.refreshRequestedAt` (string | null, required) - format `date-time` - `ListIdentityProviders.response.200.identityProviders.name` (string, required) - `ListIdentityProviders.response.200.identityProviders.oidc` (one of, required) - one of: [IdpOidc](/sso-api/schemas/IdpOidc/), `null` - `ListIdentityProviders.response.200.identityProviders.organizationId` (string, required) - format `uuid` - `ListIdentityProviders.response.200.identityProviders.projectId` (string | null, required) - `ListIdentityProviders.response.200.identityProviders.protocol` (string, required) - one of `"oidc"`, `"saml"` - `ListIdentityProviders.response.200.identityProviders.provisioning` (object, required) — scim: a live directory SCIM token names this identity provider, so only provisioned users sign in; otherwise jit. - `ListIdentityProviders.response.200.identityProviders.provisioning.jit` (boolean, required) - `ListIdentityProviders.response.200.identityProviders.provisioning.scim` (boolean, required) - `ListIdentityProviders.response.200.identityProviders.region` (string, required) - `ListIdentityProviders.response.200.identityProviders.resourceName` (string, required) - `ListIdentityProviders.response.200.identityProviders.saml` (one of, required) - one of: [IdpSaml](/sso-api/schemas/IdpSaml/), `null` - `ListIdentityProviders.response.200.identityProviders.slug` (string, required) - `ListIdentityProviders.response.200.identityProviders.status` (string, required) - `ListIdentityProviders.response.200.identityProviders.tags` (map, required) - `ListIdentityProviders.response.200.identityProviders.updatedAt` (string, required) - format `date-time` - `ListIdentityProviders.response.200.nextCursor` (string | null, required) ### 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" } } } ``` - `ListIdentityProviders.response.400.error` (object, required) - `ListIdentityProviders.response.400.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `ListIdentityProviders.response.400.error.message` (string, required) - maxLength 1024 - `ListIdentityProviders.response.400.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `ListIdentityProviders.response.400.error.issues.message` (string, required) - `ListIdentityProviders.response.400.error.issues.path` (string, required) - `ListIdentityProviders.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `ListIdentityProviders.response.400.error.quota.id` (string, required) - `ListIdentityProviders.response.400.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `ListIdentityProviders.response.400.error.quota.limit` (integer, required) - min 0 - `ListIdentityProviders.response.400.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `ListIdentityProviders.response.400.error.quota.inFlight` (integer, optional) - min 0 - `ListIdentityProviders.response.400.error.quota.periodStart` (string, optional) - format `date-time` - `ListIdentityProviders.response.400.error.quota.region` (string, optional) - `ListIdentityProviders.response.400.error.quota.resetsAt` (string, optional) - format `date-time` - `ListIdentityProviders.response.400.error.quota.scopeResourceName` (string, optional) - `ListIdentityProviders.response.400.error.quota.used` (integer, optional) - min 0 - `ListIdentityProviders.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" } } } ``` - `ListIdentityProviders.response.401.error` (object, required) - `ListIdentityProviders.response.401.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `ListIdentityProviders.response.401.error.message` (string, required) - maxLength 1024 - `ListIdentityProviders.response.401.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `ListIdentityProviders.response.401.error.issues.message` (string, required) - `ListIdentityProviders.response.401.error.issues.path` (string, required) - `ListIdentityProviders.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `ListIdentityProviders.response.401.error.quota.id` (string, required) - `ListIdentityProviders.response.401.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `ListIdentityProviders.response.401.error.quota.limit` (integer, required) - min 0 - `ListIdentityProviders.response.401.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `ListIdentityProviders.response.401.error.quota.inFlight` (integer, optional) - min 0 - `ListIdentityProviders.response.401.error.quota.periodStart` (string, optional) - format `date-time` - `ListIdentityProviders.response.401.error.quota.region` (string, optional) - `ListIdentityProviders.response.401.error.quota.resetsAt` (string, optional) - format `date-time` - `ListIdentityProviders.response.401.error.quota.scopeResourceName` (string, optional) - `ListIdentityProviders.response.401.error.quota.used` (integer, optional) - min 0 - `ListIdentityProviders.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" } } } ``` - `ListIdentityProviders.response.403.error` (object, required) - `ListIdentityProviders.response.403.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `ListIdentityProviders.response.403.error.message` (string, required) - maxLength 1024 - `ListIdentityProviders.response.403.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `ListIdentityProviders.response.403.error.issues.message` (string, required) - `ListIdentityProviders.response.403.error.issues.path` (string, required) - `ListIdentityProviders.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `ListIdentityProviders.response.403.error.quota.id` (string, required) - `ListIdentityProviders.response.403.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `ListIdentityProviders.response.403.error.quota.limit` (integer, required) - min 0 - `ListIdentityProviders.response.403.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `ListIdentityProviders.response.403.error.quota.inFlight` (integer, optional) - min 0 - `ListIdentityProviders.response.403.error.quota.periodStart` (string, optional) - format `date-time` - `ListIdentityProviders.response.403.error.quota.region` (string, optional) - `ListIdentityProviders.response.403.error.quota.resetsAt` (string, optional) - format `date-time` - `ListIdentityProviders.response.403.error.quota.scopeResourceName` (string, optional) - `ListIdentityProviders.response.403.error.quota.used` (integer, optional) - min 0 - `ListIdentityProviders.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" } } } ``` - `ListIdentityProviders.response.404.error` (object, required) - `ListIdentityProviders.response.404.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `ListIdentityProviders.response.404.error.message` (string, required) - maxLength 1024 - `ListIdentityProviders.response.404.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `ListIdentityProviders.response.404.error.issues.message` (string, required) - `ListIdentityProviders.response.404.error.issues.path` (string, required) - `ListIdentityProviders.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `ListIdentityProviders.response.404.error.quota.id` (string, required) - `ListIdentityProviders.response.404.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `ListIdentityProviders.response.404.error.quota.limit` (integer, required) - min 0 - `ListIdentityProviders.response.404.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `ListIdentityProviders.response.404.error.quota.inFlight` (integer, optional) - min 0 - `ListIdentityProviders.response.404.error.quota.periodStart` (string, optional) - format `date-time` - `ListIdentityProviders.response.404.error.quota.region` (string, optional) - `ListIdentityProviders.response.404.error.quota.resetsAt` (string, optional) - format `date-time` - `ListIdentityProviders.response.404.error.quota.scopeResourceName` (string, optional) - `ListIdentityProviders.response.404.error.quota.used` (integer, optional) - min 0 - `ListIdentityProviders.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" } } } ``` - `ListIdentityProviders.response.429.error` (object, required) - `ListIdentityProviders.response.429.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `ListIdentityProviders.response.429.error.message` (string, required) - maxLength 1024 - `ListIdentityProviders.response.429.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `ListIdentityProviders.response.429.error.issues.message` (string, required) - `ListIdentityProviders.response.429.error.issues.path` (string, required) - `ListIdentityProviders.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `ListIdentityProviders.response.429.error.quota.id` (string, required) - `ListIdentityProviders.response.429.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `ListIdentityProviders.response.429.error.quota.limit` (integer, required) - min 0 - `ListIdentityProviders.response.429.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `ListIdentityProviders.response.429.error.quota.inFlight` (integer, optional) - min 0 - `ListIdentityProviders.response.429.error.quota.periodStart` (string, optional) - format `date-time` - `ListIdentityProviders.response.429.error.quota.region` (string, optional) - `ListIdentityProviders.response.429.error.quota.resetsAt` (string, optional) - format `date-time` - `ListIdentityProviders.response.429.error.quota.scopeResourceName` (string, optional) - `ListIdentityProviders.response.429.error.quota.used` (integer, optional) - min 0 - `ListIdentityProviders.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" } } } ``` - `ListIdentityProviders.response.500.error` (object, required) - `ListIdentityProviders.response.500.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `ListIdentityProviders.response.500.error.message` (string, required) - maxLength 1024 - `ListIdentityProviders.response.500.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `ListIdentityProviders.response.500.error.issues.message` (string, required) - `ListIdentityProviders.response.500.error.issues.path` (string, required) - `ListIdentityProviders.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `ListIdentityProviders.response.500.error.quota.id` (string, required) - `ListIdentityProviders.response.500.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `ListIdentityProviders.response.500.error.quota.limit` (integer, required) - min 0 - `ListIdentityProviders.response.500.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `ListIdentityProviders.response.500.error.quota.inFlight` (integer, optional) - min 0 - `ListIdentityProviders.response.500.error.quota.periodStart` (string, optional) - format `date-time` - `ListIdentityProviders.response.500.error.quota.region` (string, optional) - `ListIdentityProviders.response.500.error.quota.resetsAt` (string, optional) - format `date-time` - `ListIdentityProviders.response.500.error.quota.scopeResourceName` (string, optional) - `ListIdentityProviders.response.500.error.quota.used` (integer, optional) - min 0 - `ListIdentityProviders.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" } } } ``` - `ListIdentityProviders.response.503.error` (object, required) - `ListIdentityProviders.response.503.error.code` (string, required) - maxLength 64; pattern `^[a-z][a-z0-9_]*$` - `ListIdentityProviders.response.503.error.message` (string, required) - maxLength 1024 - `ListIdentityProviders.response.503.error.issues` (array, optional) — invalid_request: one entry per problem, at a dotted path. - `ListIdentityProviders.response.503.error.issues.message` (string, required) - `ListIdentityProviders.response.503.error.issues.path` (string, required) - `ListIdentityProviders.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After. - `ListIdentityProviders.response.503.error.quota.id` (string, required) - `ListIdentityProviders.response.503.error.quota.kind` (unknown, required) - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"` - `ListIdentityProviders.response.503.error.quota.limit` (integer, required) - min 0 - `ListIdentityProviders.response.503.error.quota.scope` (unknown, required) - one of `"organization"`, `"project"`, `"resource"` - `ListIdentityProviders.response.503.error.quota.inFlight` (integer, optional) - min 0 - `ListIdentityProviders.response.503.error.quota.periodStart` (string, optional) - format `date-time` - `ListIdentityProviders.response.503.error.quota.region` (string, optional) - `ListIdentityProviders.response.503.error.quota.resetsAt` (string, optional) - format `date-time` - `ListIdentityProviders.response.503.error.quota.scopeResourceName` (string, optional) - `ListIdentityProviders.response.503.error.quota.used` (integer, optional) - min 0 - `ListIdentityProviders.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H. Source: https://docs.ezghcloud.com/sso-api/ListIdentityProviders/index.md