# Retrieve an Identity Provider

To retrieve an IDP, perform a `GET` request with the `identityProviderId` of the IDP.

## Endpoint

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

## Request

{% hint style="info" %}
**Note:** The following request contains a sample `identityProviderId`. Replace it with the `identityProviderId` value, whose information you want to retrieve.
{% endhint %}

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

{% tabs %}
{% tab title="Path Parameters" %}
Below is the list of mandatory path parameter:

| **Body Parameters**  | **Type** | **Description**           | **Example**                            |
| -------------------- | -------- | ------------------------- | -------------------------------------- |
| `identityProviderId` | string   | The ID (UUID) of the IDP. | `5e6323da-8a45-5732-bec1-d7c29c1dc890` |
| {% endtab %}         |          |                           |                                        |

{% tab title="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, [<mark style="color:blue;">Generate authentication token</mark>](https://docs.ionos.com/sections-test/guides/set-up-ionos-cloud/management/token-manager#generate-authentication-token). |
| `Content-Type`        |      yes     |  string  | Set this to `application/json`.                                                                                                                                                                                                                                                        |
| {% endtab %}          |              |          |                                                                                                                                                                                                                                                                                        |
| {% endtabs %}         |              |          |                                                                                                                                                                                                                                                                                        |

## Response

**200 Successful operation**

{% tabs %}
{% tab title="OIDC" %}

```bash
{
  "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": "yourDomain.com",
    "configuration": {
      "oidc": {
        "openidConfigurationUrl": "https://example.com/.well-known/openid-configuration",
        "clientName": "Example Client",
        "endpoint": "https://iam.ionos.com/realms/cloud/.well-known/openid-configuration"
      }
    }
  }
}
```

{% endtab %}

{% tab title="SAML" %}

```bash
{
  "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>",
    "redirectURI": "https://iam.ionos.com/realms/cloud/broker/identityProviderId/endpoint",
    "webOrigin": "https://iam.ionos.com"
  },
  "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"
      }
    }
  }
}
```

{% endtab %}
{% endtabs %}