Skip to main content
GET
Fetch a single 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.

Response

Client IdP fetched.

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>