Preparing an Initial Subdomain Name

From the owner of that customer account, obtain an initial subdomain name (for instance, example.onmicrosoft.com). This name will be used to create a Microsoft account in the Microsoft cloud. After obtaining that initial subdomain name, you must check whether it is available. If it is not available, ask the owner to provide a different initial subdomain name.

To check the availability of an initial subdomain name, use the checkSubdomainAvailable custom operation of your application instance, as explained below.

Important: Checking the availability of initial subdomain names is a custom operation. The user whose key and secret you use to access the APS REST API must have http://www.parallels.com/Office365/Office365app and GET in its list of allowed operations.

HTTP Request

GET https://BRAND_DOMAIN/aps/2/resources/APS_ID_OF_APP_INSTANCE/checkSubdomainAvailable?subdomain=INITIAL_SUBDOMAIN_NAME

Note: For INITIAL_SUBDOMAIN_NAME, use values without .onmicrosoft.com.

HTTP Response

{
  "available": true
}

or

{
  "available": false
}

Example

HTTP Request

GET https://example.com/aps/2/resources/475292a0-3553-4c27-a2a4-16094f50d95c/checkSubdomainAvailable?subdomain=example

HTTP Response

{
  "available": true
}