> For the complete documentation index, see [llms.txt](https://docs.ionos.com/cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ionos.com/cloud/set-up-ionos-cloud/management/identity-access-management/iam-federation/api-how-tos.md).

# API How-Tos

With IAM Federation APIs, learn how to set user privileges, create and manage Identity Providers (IDPs), request and manage domain ownership, and user account linking with IAM Federation.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><mark style="color:blue;"><strong>Set User Privileges through the API</strong></mark></td><td>Set required user privileges for a user to manage IAM resources.</td><td><a href="/cloud/set-up-ionos-cloud/management/identity-access-management/iam-federation/api-how-tos/set-user-privileges-identity-federation-api.md">Set User Privileges through the API</a></td></tr><tr><td><mark style="color:blue;"><strong>Create Identity Provider</strong></mark></td><td>Learn how to create an IDP for your organization using the API.</td><td><a href="/cloud/set-up-ionos-cloud/management/identity-access-management/iam-federation/api-how-tos/create-identity-provider.md">Create Identity Provider</a></td></tr><tr><td><mark style="color:blue;"><strong>Retrieve Identity Provider</strong></mark></td><td>Learn how to retrieve an IDP for an organization using the API.</td><td><a href="/cloud/set-up-ionos-cloud/management/identity-access-management/iam-federation/api-how-tos/retrieve-identity-provider.md">Retrieve an Identity Provider</a></td></tr><tr><td><mark style="color:blue;"><strong>Retrieve all Identity Providers</strong></mark></td><td>Learn how to retrieve all associated IDPs for an organization using the API.</td><td><a href="/cloud/set-up-ionos-cloud/management/identity-access-management/iam-federation/api-how-tos/retrieve-all-identity-providers.md">Retrieve all Identity Providers</a></td></tr><tr><td><mark style="color:blue;"><strong>Ensure Identity Provider</strong></mark></td><td>Learn how to update an existing IDP of an organization using the API.</td><td><a href="/cloud/set-up-ionos-cloud/management/identity-access-management/iam-federation/api-how-tos/ensure-identity-provider.md">Ensure Identity Provider</a></td></tr><tr><td><mark style="color:blue;"><strong>Delete Identity Provider</strong></mark></td><td>Learn how to delete an IDP associated with your organization using the API.</td><td><a href="/cloud/set-up-ionos-cloud/management/identity-access-management/iam-federation/api-how-tos/delete-identity-provider.md">Delete an Identity Provider</a></td></tr><tr><td><mark style="color:blue;"><strong>Request Domain Ownership</strong></mark></td><td>Learn how to map the organization domain to establish IDP connection using the API.</td><td><a href="/cloud/set-up-ionos-cloud/management/identity-access-management/iam-federation/api-how-tos/request-domain-ownership.md">Request Domain Ownership</a></td></tr><tr><td><mark style="color:blue;"><strong>Retrieve Domain</strong></mark></td><td>Learn how to retrieve the organization domain using the API.</td><td><a href="/cloud/set-up-ionos-cloud/management/identity-access-management/iam-federation/api-how-tos/retrieve-domain.md">Retrieve Domain</a></td></tr><tr><td><mark style="color:blue;"><strong>Retrieve all Domains</strong></mark></td><td>Learn how to retrieve all the domains associated with the organization using the API.</td><td><a href="/cloud/set-up-ionos-cloud/management/identity-access-management/iam-federation/api-how-tos/retrieve-all-domains.md">Retrieve all Domains</a></td></tr><tr><td><mark style="color:blue;"><strong>Verify Domain Ownership</strong></mark></td><td>Learn how to verify the ownership of the domain associated with the organization using the API.</td><td><a href="/cloud/set-up-ionos-cloud/management/identity-access-management/iam-federation/api-how-tos/verify-domain-ownership.md">Verify Domain Ownership</a></td></tr><tr><td><mark style="color:blue;"><strong>Retrieve Link</strong></mark></td><td>Learn how to retrieve a link of the account associated with the IAM Federation using the API.</td><td><a href="/cloud/set-up-ionos-cloud/management/identity-access-management/iam-federation/api-how-tos/retrieve-link.md">Retrieve Link</a></td></tr><tr><td><mark style="color:blue;"><strong>Retrieve all Links</strong></mark></td><td>Learn how to retrieve all links of the accounts associated with the IAM Federation using the API.</td><td><a href="/cloud/set-up-ionos-cloud/management/identity-access-management/iam-federation/api-how-tos/retrieve-all-links.md">Retrieve all Links</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ionos.com/cloud/set-up-ionos-cloud/management/identity-access-management/iam-federation/api-how-tos.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
