Skip to main content
PUT
Replace a client IdP.

Authorizations

Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Path Parameters

id
string
required

Internal record ID hex or custom client_idp_id.

Body

application/json
name
string
required

Human-readable name. Required.

jwks_uri
string
required

JWKS endpoint URL. Required — this is the IdP's signing-key source with no discovery fallback.

client_idp_id
string

Optional stable identifier. If not provided, defaults to the record's internal ID hex. Must be unique within the org.

issuer
string

Issuer URL. Optional — used as a selection hint downstream; an empty value is accepted.

scope_claim_name
string

JWT claim that holds the OAuth scopes (e.g. scope, scp, roles). Optional — when empty the gateway falls back to the scope claim.

api_mappings
object

Map of api_id → ScopeMapping. Defaults to an empty map if not provided.

Example:

Response

Client IdP updated.

A client Identity Provider stored beside API definitions.

_id
string

Internal record ID hex. Set server-side on creation.

client_idp_id
string

Stable user-facing identifier. Defaults to _id hex when not supplied on create.

org_id
string

Organisation ID. Set server-side from the session; cannot be overridden.

name
string
issuer
string
jwks_uri
string
scope_claim_name
string

JWT claim holding the OAuth scopes (e.g. scope, scp, roles). Empty falls back to scope gateway-side.

api_mappings
object

Map of api_id → ScopeMapping.

Example:
date_created
string<date-time>
last_updated
string<date-time>