Request Domain Ownership

Prerequisite: Only contract administrators, owners, and users with accessAndManageIamResources privilege can create and manage Identity Providers (IDPs) through the API. You can also set user privileges in the DCD. For more information, see Set User Privileges for Identity and Access Management.

To request the ownership of a domain, perform a POST request.

Endpoint

Use the following endpoint to request for domain ownership: https://iam.ionos.com/federation/domains.

Request

curl --X \  
--request POST 'https://iam.ionos.com/federation/domains' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJraWQiO' \
--header 'Content-Type: application/json' \
--data '{
  "domain": "yourcompany.com"
}'

Request Body Parameters

Below is the list of mandatory body parameters:

Body Parameters	Type	Description	Example
domain	string	Represents the domain to map the user email domains to the IDPs.	yourcompany.com

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

202 Successful operation

{
   "id":"5e6323da-8a45-5732-bec1-d7c29c1dc890",
   "type":"domain",
   "href":"/domain/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":{
      "token":"9019680770992564882066368772815872312262977566198195",
      "domain":"yourcompany.com",
      "status":"REQUESTED",
      "message":"The token provided should be added to the TXT Domain Record, then request to verify the ownership. Important: This is the only time the token will be visible to you, so please take note of it now."
   }
}

Note: The token value provided in the API response must be saved, as this will be the only time it is displayed. This token value must be added to the TXT Domain Record before verifying the domain ownership.