External OpenID providers

Read external OpenID provider

GET/v4/config/ows/issuer/openid-providers/{providerId}

Returns one external OpenID provider of the organisation. The client secret is write-only: the response has clientSecretConfigured, never the secret.

Language of the request sample

curl 'https://demo-api.igrant.io/v4/config/ows/issuer/openid-providers/3f6c2a9e-7b1d-4c58-9e2f-1a4b6d8c0e57' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "oidcProvider": {
    "id": "3f6c2a9e-7b1d-4c58-9e2f-1a4b6d8c0e57",
    "name": "Example Bank login",
    "issuer": "https://login.example-bank.com",
    "clientId": "igrant-issuer",
    "clientSecretConfigured": true,
    "scopes": "openid profile email",
    "claimsGatheringCallbackUri": "https://issuer.example-bank.com/claims",
    "isBuiltInConformance": false,
    "createdAt": 1794365298,
    "updatedAt": 1794365298
  }
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:authorization-servers:read

Path parameters

providerIdstring<uuid>required
The id of an external OpenID provider of the organisation, from List external OpenID providers. A value that is not a UUID gives HTTP 400 (providerId: invalid type).
Example:"3f6c2a9e-7b1d-4c58-9e2f-1a4b6d8c0e57"

Response

application/json

The provider.

oidcProviderobject
An external OpenID provider of the organisation: the OpenID Connect provider where the holder logs in during an authorisation code issuance of a credential definition that names it (externalOpenidProviderId). The client secret is write-only: the response only says whether one is stored (clientSecretConfigured).