Checking the Status of the Microsoft Account

A Microsoft account can be registered for a customer account if the following conditions are met:

• This Microsoft account can be found in the Microsoft cloud by its initial subdomain name.
• This Microsoft account is not already registered for the customer account.
• This Microsoft account is connected with the CSP partner account of your application instance.
• The Microsoft Customer Agreement is accepted for this Microsoft account.

• The ownership of this Microsoft account is verified.

  Note: This condition is checked only if this Microsoft account is already registered for another customer account.

To check whether the conditions above are met, use the getDomainOwnershipDetailsByDomain custom operation of your application instance, as described below.

Important: Checking the status of a Microsoft account 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_APPLICATION_INSTANCE/getDomainOwnershipDetailsByDomain?domain=INITIAL_SUBDOMAIN_NAME&planId=SYSTEM_ID_OF_SERVICE_PLAN&accountId=SYSTEM_ID_OF_CUSTOMER_ACCOUNT

This HTTP request has the following parameters:

• BRAND_DOMAIN: Your brand domain.
• APS_ID_OF_APPLICATION_INSTANCE: The APS ID of your application instance.

• INITIAL_SUBDOMAIN_NAME: The initial subdomain name that you obtained from your customer.

  Note: For this parameter, use values without .onmicrosoft.com.

• SYSTEM_ID_OF_SERVICE_PLAN: The system identifier of the service plan that will be used for registration.
• SYSTEM_ID_OF_CUSTOMER_ACCOUNT: The system identifier of the customer account.

HTTP Response

This HTTP response contains a JSON object with the following properties:

• isNotOwned: This indicates the absence of a Microsoft account in the Microsoft cloud for the specified initial subdomain name:

  • true means no Microsoft account is found in the Microsoft cloud for the specified initial subdomain name.
  • false means a Microsoft account is found in the Microsoft cloud for the specified initial subdomain name.
• isOwnedByOSAAccount: This indicates whether the Microsoft account with the specified initial subdomain name is already registered for the customer account with the specified system identifier (true or false).
• invitationIsRequired: This indicates whether the owner of the Microsoft account must connect it with the CSP partner account of your application instance (true or false).
• isAvailableForBinding: This indicates whether the Microsoft account can be registered for the customer account (true or false). If false is returned, see the isNotOwned and isOwnedByOSAAccount parameters to learn details.
• validation_is_required: This indicates whether ownership validation is required for the Microsoft account (true or false).
• ms_tenant_id: The Microsoft ID of the Microsoft account.

• trial_plan_validation_result: This contains the result of checks for trial license conflicts between the licenses that the Microsoft account already has and the licenses included in the service plan that will be used for registration.

  • validationCode: This contains a result code (0 means there are no trial license conflicts).

  Notes:
  
  1. A Microsoft account that has a paid cloud subscription with a license cannot be provided with a trial cloud subscription with the same license.
  
  2. A Microsoft account cannot have two or more trial cloud subscriptions with the same license.

• is_acceptance_of_microsoft_cloud_agreement_required: This indicates whether the acceptance of the Microsoft Customer Agreement is required for the Microsoft account (true or false).

• onboarding_validation_status: This is a JSON object that contains information for ownership validation. It has the following properties:

  • dns_record_name: This contains the attribute name for the DNS TXT record that must be created in the initial subdomain of the Microsoft account.
  • dns_record_value: This contains the attribute value for the DNS TXT record that must be created in the initial subdomain of the Microsoft account.
  • is_dns_record_created: This indicates whether the validation DNS record exists in the initial subdomain of the Microsoft account (true or false).
  • user_login: This contains the user name of the validation user that must be created in the Microsoft account.
  • is_user_created: This indicates whether the validation user exists in the Microsoft account.

  Note: To confirm the ownership of a Microsoft account, either a validation user or a validation DNS record must be created.

• relationship_request_info: This is a JSON object that contains information that you must use to connect the Microsoft account with the CSP partner account of your application instance.

  • url: This contains the URL of an invitation page on which the owner of that Microsoft account can connect it with your CSP partner account.
  • account_email: This contains the email address of the owner of the Microsoft account.
  • account_first_name: This contains the first name of the owner of the Microsoft account.
  • account_last_name: This contains the last name of the owner of the Microsoft account.
  • provider_display_name: This contains the display name of the CSP partner account of your application instance.

  • reseller_display_name:

    • If your CSP partner account is a direct CSP provider account and the customer account belongs to your direct CSP provider account, this contains the display name of your CSP partner account.
    • If your CSP partner account is an indirect CSP provider account and the customer account belongs to an indirect CSP reseller account, this contains the display name of that CSP reseller account.

Note: Some properties are omitted depending on the current status of a Microsoft account.

Example

HTTP Request

GET https://example.com/aps/2/resources/498c7d95-54ef-45c1-9877-da03ec230993/getDomainOwnershipDetailsByDomain?domain=example&planId=20&accountId=1000014

HTTP Response

{
  "isNotOwned": false,
  "isOwnedByOSAAccount": false,
  "invitationIsRequired": false,
  "isAvailableForBinding": true,
  "validation_is_required": true,
  "ms_tenant_id": "3f8a1aff-6a93-4b2c-b734-93b66497af4c",
  "trial_plan_validation_result": {
    "validationCode": 0
  },
  "is_acceptance_of_microsoft_cloud_agreement_required": true,
  "onboarding_validation_status": {
    "dns_record_name": "vrf",
    "dns_record_value": "d038d39e_93b66497af4c",
    "is_dns_record_created": false,
    "user_login": "vrf_d038d39e_93b66497af4c@example.onmicrosoft.com",
    "is_user_created": true
  },
  "relationship_request_info": {
    "url": "https://admin.microsoft.com/Adminportal/Home?invType=ResellerRelationship&partnerId=4803cfb4-863b-4200-861a-185da7a94758&msppId=0&DAP=true#/BillingAccounts/partner-invitation",
    "account_email": "simonmonk@example.com",
    "account_first_name": "Simon",
    "account_last_name": "Monk",
    "provider_display_name": "CSP Partner",
    "reseller_display_name": "CSP Partner"
  }
}