Retrieve all Links

To retrieve all links of the accounts associated with the IAM Federation in the form of an ID, perform a GET request.

Endpoint

Use the following endpoint to retrieve all links: https://iam.ionos.com/federation/links.

Request

curl --location \
--request GET 'https://iam.ionos.com/federation/links' \
--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": "c003494a-e8a1-5a00-bf65-d94f98f69027",
  "type": "collection",
  "href": "/links",
  "items": [
    {
      "id": "5eb3d304-dc75-56cb-9b94-152533912d33",
      "type": "link",
      "href": "/links/5eb3d304-dc75-56cb-9b94-152533912d33",
      "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": {
        "id": "ac6f04c2-68e1-5e61-97c8-ef0216f1c08e",
        "providerAlias": "oidc",
        "displayName": "IdentityProvider ABC",
        "linkedUsername": "linkedUsername ABC",
        "linked": true
      }
    }
  ]
}