Identity Provider

List identity providers

GET/v4/config/platform/idp/open-ids

Lists the identity providers of the organisation, one page at a time. An organisation has at most one identity provider, so the list has 0 or 1 items. Each item contains the client secret in clear text.

Language of the request sample

curl 'https://demo-api.igrant.io/v4/config/platform/idp/open-ids' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "idps": [
    {
      "id": "6af0830a2d6fb7b6ac6efc90",
      "issuerUrl": "https://login.example.com/realms/customers",
      "authorisationUrl": "https://login.example.com/realms/customers/protocol/openid-connect/auth",
      "tokenUrl": "https://login.example.com/realms/customers/protocol/openid-connect/token",
      "logoutUrl": "https://login.example.com/realms/customers/protocol/openid-connect/logout",
      "clientId": "privacy-dashboard",
      "clientSecret": "<client-secret>",
      "jwksUrl": "https://login.example.com/realms/customers/protocol/openid-connect/certs",
      "userInfoUrl": "https://login.example.com/realms/customers/protocol/openid-connect/userinfo",
      "defaultScope": "openid profile email",
      "acceptedAudiences": null
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalItems": 1,
    "totalPages": 1,
    "limit": 10,
    "hasPrevious": false,
    "hasNext": false
  }
}

Authorizations

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

Query parameters

offsetinteger
Number of records to skip for pagination. A negative or unreadable value falls back to 0.
At least 0.
Default:0
limitinteger
Maximum number of records to return per page.
Default:10

Response

application/json

One page of identity providers.

idpsobject[]
paginationobject