Providers

List providers

Returns a list of providers in the specified zone. Pass filter[id] (repeatable, max 100) to restrict results to a known set of provider IDs; unknown or malformed IDs are silently omitted.

get/zones/{zoneId}/providers

Path parameters

zoneIdstring required

Query parameters

slugstring
identifierstring
type'external' | 'keycard-vault' | 'keycard-sts'
string

Restrict results to providers with this ID. Repeatable, max 100.

OR
string[]
cursorstring
afterstring

Cursor for forward pagination

beforestring

Cursor for backward pagination

limitinteger

Maximum number of items to return

'total_count'
OR
string[]

Response

Default Response

Changes

Changed in 8 of the 23 revisions of this API.2221

    • added the new optional query request parameter filter[id]

      new-optional-request-parameter

    • added the optional property items/items/metadata/icon_url to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/protocols/openid/external_id_claim to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/protocols/openid/single_logout_enabled to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/protocols/openid/scopes to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/protocols/openid/user_identifier_claim to the response with the 200 status

      response-optional-property-added

    • the endpoint scheme security OAuth2 was added to the API

      api-security-added

    • the endpoint scheme security bearerAuth was added to the API

      api-security-added

    • the endpoint scheme security iam_bearerAuth was removed from the API

      api-security-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • for the query request parameter limit, default value was changed from 100 to 20

      request-parameter-default-value-changed

    • for the query request parameter limit, the max was decreased from 1000.00 to 100.00

      request-parameter-max-decreased

    • added the new optional query request parameter after

      new-optional-request-parameter

    • added the new optional query request parameter before

      new-optional-request-parameter

    • added the new optional query request parameter expand[]

      new-optional-request-parameter

    • added the optional property items/items/protocols/oauth2/authorization_parameters to the response with the 200 status

      response-optional-property-added

    • added the required property items/items/owner_type to the response with the 200 status

      response-required-property-added

    • added the required property items/items/protocols/oauth2/issuer to the response with the 200 status

      response-required-property-added

    • added the required property pagination to the response with the 200 status

      response-required-property-added

    • added the optional property items/items/protocols/oauth2/scope_parameter to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/protocols/oauth2/scope_separator to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/protocols/oauth2/token_response_access_token_pointer to the response with the 200 status

      response-optional-property-added

    • removed the optional property items/items/domains from the response with the 200 status

      response-optional-property-removed

    • removed the optional property items/items/metadata/internal_claims from the response with the 200 status

      response-optional-property-removed

    • added the optional property items/items/protocols/oauth2/authorization_resource_enabled to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/protocols/oauth2/authorization_resource_parameter to the response with the 200 status

      response-optional-property-added

    This revision also has 82 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog