Identity Provider

Delete identity provider

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

Deletes the identity provider of the organisation. Your individuals then cannot log in with it, and the service no longer accepts its tokens. The individuals that logged in with it stay. You can then create a new identity provider.

Language of the request sample

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

{
  "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": null
  }
}

Authorizations

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

Path parameters

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

Response

application/json

The deleted 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.