Sign in
Providers

Get provider

Returns details of a specific Provider by ID

get/zones/{zoneId}/providers/{id}

Path parameters

zoneIdstring required
idstring required

Response

A Provider is a system that supplies access to Resources and allows actors (Users or Applications) to authenticate.

idstring required

Unique identifier of the provider

organization_idstring required

Organization that owns this provider

zone_idstring required

Zone this provider belongs to

slugstring required

URL-safe identifier, unique within the zone

namestring required

Human-readable name

descriptionstring nullable

Human-readable description

identifierstring required

User specified identifier, unique within the zone

type'external' | 'keycard-vault' | 'keycard-sts'
client_idstring nullable

OAuth 2.0 client identifier

client_secret_setboolean

Indicates whether a client secret is configured

owner_type'platform' | 'customer' required

Who owns this provider. Platform-owned providers cannot be modified via API.

created_atstring date-time required

Entity creation timestamp

updated_atstring date-time required

Entity update timestamp

Changes

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

  • d65d51379d933See the full diff
    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

  • 2f5033ed44911See the full diff
    • ○

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

      response-optional-property-added

  • ffb6f697525f1See the full diff
    • ○

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

      response-optional-property-added

  • aee6e66de0d31See the full diff
    • ○

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

      response-optional-property-added

  • d3d69f45bfed3See the full diff
    • ○

      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

  • cb43483cd1b33See the full diff
    • ○

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

      response-optional-property-added

    • ○

      added the required property owner_type to the response with the 200 status

      response-required-property-added

    • ○

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

      response-required-property-added

  • 0aa1f5c87e813See the full diff
    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

  • edd1b760a98922See the full diff
    • ●

      removed the optional property domains from the response with the 200 status

      response-optional-property-removed

    • ●

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

      response-optional-property-removed

    • ○

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

      response-optional-property-added

    • ○

      added the optional property 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