Application Credentials5

Applications11

Delegated Grants4

Groups11

Invitations4

Policies5

PolicyBindings5

PolicyBundle3

PolicyDrafts3

PolicyEvaluations2

PolicySchemas3

PolicySetDrafts6

PolicySets5

PolicySetVersions6

PolicyValidations1

PolicyVersions4

Providers6

Resources5

Roles1

Sessions5

svc-org-management_other30

svc-vault-api_other5

User Agents2

Users4

Zone Members5

Zone Roles11

Zones5

Providers

Create provider

Creates a new Provider - a system that supplies access to Resources and allows actors to authenticate

post/zones/{zoneId}/providers

Path parameters

zoneIdstring required

Request body

namestring safe-text required

Human-readable name. Must not contain HTML tags (e.g. <script>, <div>) or control characters.

descriptionstring safe-text nullable

Human-readable description. Must not contain HTML tags (e.g. <script>, <div>) or control characters.

identifierstring safe-text required

User specified identifier, unique within the zone. Must not contain HTML tags (e.g. <script>, <div>) or control characters.

client_idstring

OAuth 2.0 client identifier

client_secretstring

OAuth 2.0 client secret (will be encrypted and stored securely)

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 9 of the 23 revisions of this API.3430

Aug 26, 2026d65d51379d936See the full diff
- ○
  added the new optional request property metadata/icon_url
  new-optional-request-property
- ○
  added the new optional request property protocols/openid/external_id_claim
  new-optional-request-property
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 403
  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
Jul 1, 20262f5033ed44912See the full diff
- ○
  added the new optional request property protocols/openid/single_logout_enabled
  new-optional-request-property
- ○
  added the optional property protocols/openid/single_logout_enabled to the response with the 200 status
  response-optional-property-added
May 22, 2026ffb6f697525f2See the full diff
- ○
  added the new optional request property protocols/openid/scopes
  new-optional-request-property
- ○
  added the optional property protocols/openid/scopes to the response with the 200 status
  response-optional-property-added
Apr 20, 2026932699a5ea163See the full diff
- ▲
  the description request property type/format changed from string/ to string/safe-text
  request-property-type-changed
- ▲
  the identifier request property type/format changed from string/ to string/safe-text
  request-property-type-changed
- ▲
  the name request property type/format changed from string/ to string/safe-text
  request-property-type-changed
Apr 2, 2026aee6e66de0d32See the full diff
- ○
  added the new optional request property protocols/openid/user_identifier_claim
  new-optional-request-property
- ○
  added the optional property protocols/openid/user_identifier_claim to the response with the 200 status
  response-optional-property-added
Mar 16, 2026d3d69f45bfed3See 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
Mar 9, 2026cb43483cd1b35See the full diff
- ○
  added the new optional request property protocols/oauth2/authorization_parameters
  new-optional-request-property
- ○
  added the new optional request property protocols/oauth2/issuer
  new-optional-request-property
- ○
  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
Feb 24, 20260aa1f5c87e816See the full diff
- ○
  added the new optional request property protocols/oauth2/scope_parameter
  new-optional-request-property
- ○
  added the new optional request property protocols/oauth2/scope_separator
  new-optional-request-property
- ○
  added the new optional request property protocols/oauth2/token_response_access_token_pointer
  new-optional-request-property
- ○
  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
Feb 6, 2026edd1b760a98944See the full diff
- ●
  removed the request property domains
  request-property-removed
- ●
  removed the request property metadata/internal_claims
  request-property-removed
- ●
  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 new optional request property protocols/oauth2/authorization_resource_enabled
  new-optional-request-property
- ○
  added the new optional request property protocols/oauth2/authorization_resource_parameter
  new-optional-request-property
- ○
  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

Full history