API docs by Redocly

IONOS Cloud - IAM Federation API (1.1.0)

Download OpenAPI specification:Download

APIs for managing the identity providers and organizations at IONOS.

IdentitiesProvider

Identity provider federation for identity brokering.

This tag groups all operations for identitiesprovider.

Retrieve all IdentitiesProvider

This endpoint enables retrieving all IdentitiesProvider using pagination and optional filters.

Authorizations:
tokenAuth

Responses

Response samples

Content type
application/json
{}

Create IdentityProvider

Creates a new IdentityProvider.

The full IdentityProvider needs to be provided to create the object. Optional data will be filled with defaults or left empty.

Authorizations:
tokenAuth
Request Body schema: application/json

IdentityProvider to create.

object

Metadata

required
object (IdentityProvider)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Retrieve IdentityProvider

Returns the IdentityProvider by ID.

Authorizations:
tokenAuth
path Parameters
identityProviderId
required
string <uuid>
Example: 5e6323da-8a45-5732-bec1-d7c29c1dc890

The ID (UUID) of the IdentityProvider.

Responses

Response samples

Content type
application/json
{}

Ensure IdentityProvider

Ensures that the IdentityProvider with the provided ID is created or modified. The full IdentityProvider needs to be provided to ensure (either update or create) the IdentityProvider. Non present data will only be filled with defaults or left empty, but not take previous values into consideration.

Authorizations:
tokenAuth
path Parameters
identityProviderId
required
string <uuid>
Example: 5e6323da-8a45-5732-bec1-d7c29c1dc890

The ID (UUID) of the IdentityProvider.

Request Body schema: application/json

update IdentityProvider

id
required
string <uuid>

The ID (UUID) of the IdentityProvider.

object

Metadata

required
object (IdentityProvider)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Delete IdentityProvider

Deletes the specified IdentityProvider.

Authorizations:
tokenAuth
path Parameters
identityProviderId
required
string <uuid>
Example: 5e6323da-8a45-5732-bec1-d7c29c1dc890

The ID (UUID) of the IdentityProvider.

Responses

Response samples

Content type
application/json
{
  • "httpStatus": 400,
  • "messages": [
    ]
}

Retrieve all Link

This endpoint enables retrieving all Link using pagination and optional filters.

Authorizations:
tokenAuth

Responses

Response samples

Content type
application/json
{
  • "id": "c003494a-e8a1-5a00-bf65-d94f98f69027",
  • "type": "collection",
  • "href": "/links",
  • "items": [
    ]
}

Retrieve Link

Returns the Link by ID.

Authorizations:
tokenAuth
path Parameters
linkId
required
string <uuid>
Example: 5eb3d304-dc75-56cb-9b94-152533912d33

The ID (UUID) of the Link.

Responses

Response samples

Content type
application/json
{
  • "id": "5eb3d304-dc75-56cb-9b94-152533912d33",
  • "type": "link",
  • "href": "/links/5eb3d304-dc75-56cb-9b94-152533912d33",
  • "metadata": {
    },
  • "properties": {
    }
}

Domain

Domains provides the IAM possibility of owners and admins to manage their IdPs and email domains.

This tag groups all operations for domain.

Retrieve all Domain

This endpoint enables retrieving all Domain using pagination and optional filters.

Authorizations:
tokenAuth

Responses

Response samples

Content type
application/json
{
  • "id": "7d4a3d9d-033d-5794-99e6-d5cfa9516fc4",
  • "type": "collection",
  • "href": "/domains",
  • "items": [
    ]
}

Request Domain ownership

Request the ownership of a Domain, must be validated through TXT Domains.

Authorizations:
tokenAuth
Request Body schema: application/json

Domain to be created.

domain
required
string

The domain is used to map user email domains to identity providers.

Responses

Request samples

Content type
application/json
{
  • "domain": "yourcompany.com"
}

Response samples

Content type
application/json
{
  • "id": "5e6323da-8a45-5732-bec1-d7c29c1dc890",
  • "type": "domain",
  • "href": "/domain/5e6323da-8a45-5732-bec1-d7c29c1dc890",
  • "metadata": {
    },
  • "properties": {
    }
}

Retrieve Domain

Returns the Domain by ID.

Authorizations:
tokenAuth
path Parameters
domainId
required
string <uuid>
Example: f181c212-34f1-5843-9bbb-fc2531c7d928

The ID (UUID) of the Domain.

Responses

Response samples

Content type
application/json
{
  • "id": "f181c212-34f1-5843-9bbb-fc2531c7d928",
  • "type": "domain",
  • "href": "/domains/f181c212-34f1-5843-9bbb-fc2531c7d928",
  • "metadata": {
    },
  • "properties": {
    }
}

Delete Domain

Deletes the specified domain.

Authorizations:
tokenAuth
path Parameters
domainId
required
string
Example: yourdomain.com

The domain id.

Responses

Response samples

Content type
application/json
{
  • "httpStatus": 400,
  • "messages": [
    ]
}

Verify Domain ownership

Given the domain has been requested, validates the token is part of the Domain.

Authorizations:
tokenAuth
path Parameters
domainId
required
string <uuid>
Example: 5e6323da-8a45-5732-bec1-d7c29c1dc890

The ID (UUID) of the Domain.

Responses

Response samples

Content type
application/json
{
  • "id": "f181c212-34f1-5843-9bbb-fc2531c7d928",
  • "type": "domain",
  • "href": "/domains/f181c212-34f1-5843-9bbb-fc2531c7d928",
  • "metadata": {
    },
  • "properties": {
    }
}