Sign in

v22

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-01140308542.4 KB
Providers

Update provider

Updates a Provider's configuration and metadata

patch/zones/{zoneId}/providers/{id}

Path parameters

zoneIdstring required
idstring required

Request body

namestring safe-text

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

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

client_idstring nullable

OAuth 2.0 client identifier. Set to null to remove.

client_secretstring nullable

OAuth 2.0 client secret (will be encrypted and stored securely). Set to null to remove.

metadataobject nullable

Provider metadata. Set to null to remove all metadata.

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

metadataobject nullable

Provider metadata

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