Retrieve all Identity Providers

To retrieve all IDPs, perform a GET request.

Endpoint

Use the following endpoint to retrieve an IDP: https://iam.ionos.com/federation/identityproviders.

Request

curl --X \  
--request GET 'https://iam.ionos.com/federation/identityproviders/5e6323da-8a45-5732-bec1-d7c29c1dc890 \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJraWQiO' \
--header 'Content-Type: application/json' \

Request Header Parameters

To make authenticated requests to the API, the following fields are mandatory in the request header:

Header Parameters	Required	Type	Description
Authorization	yes	string	The Bearer token enables requests to authenticate using a JSON Web Token (JWT). From the DCD, Generate authentication token.
Content-Type	yes	string	Set this to application/json.

Response

200 Successful operation

{
  "id": "ac6f04c2-68e1-5e61-97c8-ef0216f1c08e",
  "type": "collection",
  "href": "/identityproviders",
  "items": [
    {
      "id": "5e6323da-8a45-5732-bec1-d7c29c1dc890",
      "type": "identityprovider",
      "href": "/identityproviders/5e6323da-8a45-5732-bec1-d7c29c1dc890",
      "metadata": {
        "createdDate": "2020-12-10T13:37:50+01:00",
        "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedDate": "2020-12-11T13:37:50+01:00",
        "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>"
      },
      "properties": {
        "name": "IdentityProvider ABC",
        "enabled": true,
        "domain": "ionos.com",
        "configuration": {
          "saml": {
            "metadataDescriptor": "https://yourproviderconfiguration/protocol/saml/descriptor",
            "endpoint": "https://iam.ionos.com/realms/cloud/broker/yourIdentityProvider/endpoint/descriptor"
          },
          "oidc": {
            "openidConfigurationUrl": "https://example.com/.well-known/openid-configuration",
            "clientName": "Example Client"
          }
        }
      }
    }
  ]
}