Fetch a single client IdP.

Look up a client IdP by id within the caller’s org. id may be the internal record ID hex or the custom client_idp_id string — the server tries client_idp_id first, then falls back to _id.

GET /api/clientidps/{id}

Fetch a single client IdP.

cURL

curl --request GET \
  --url https://{tenant}/api/clientidps/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "_id": "<string>",
  "client_idp_id": "<string>",
  "org_id": "<string>",
  "name": "<string>",
  "issuer": "<string>",
  "jwks_uri": "<string>",
  "scope_claim_name": "<string>",
  "api_mappings": {
    "b84fe1a04e5648927971c0557971565c": {
      "scope_to_policy": {
        "read": "665d51505715ec2d76022c87"
      }
    }
  },
  "date_created": "2023-11-07T05:31:56Z",
  "last_updated": "2023-11-07T05:31:56Z"
}

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

200

application/json

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.

Show child attributes

Example:

{
  "b84fe1a04e5648927971c0557971565c": {
    "scope_to_policy": { "read": "665d51505715ec2d76022c87" }
  }
}

date_created · string<date-time>

last_updated · string<date-time>