Identity Provider

Update identity provider

PUT/v4/config/platform/idp/open-id/{idpId}

Replaces the settings of the identity provider. Send all the members, also the client secret: the service replaces each member with the value of the request, and a member that you do not send becomes empty (acceptedAudiences becomes null). All URLs must be absolute https:// URLs with a host. The response contains the client secret in clear text.

Language of the request sample

curl -X PUT 'https://demo-api.igrant.io/v4/config/platform/idp/open-id/6af0830a2d6fb7b6ac6efc90' \
  -H 'Authorization: ApiKey <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "idp": {
    "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": [
      "https://api.example.com"
    ]
  }
}'

{
  "idp": {
    "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": [
      "https://api.example.com"
    ]
  }
}

Authorizations

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

Path parameters

idpIdstringrequired
Identity provider ID (the id of the identity provider).
Example:"6af0830a2d6fb7b6ac6efc90"

Body

application/json

idpobjectrequired
The OpenID Connect identity provider of the organisation: the login service of your own users. The individuals log in with it (for example in the privacy dashboard), and the service accepts its access tokens and ID tokens on the routes that an individual can call.

Response

application/json

The updated identity provider, with its client secret.

idpobject
The OpenID Connect identity provider of the organisation: the login service of your own users. The individuals log in with it (for example in the privacy dashboard), and the service accepts its access tokens and ID tokens on the routes that an individual can call.