Microsoft Cloud Solutions Tenant

/cloud-solutions-tenant

GET

Returns a list of tenants

Request parameters

All values are optional.

JSON response

Possible errors

Sample

curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/cloud-solutions-tenant" | python -m json.tool

POST

Create a new cloud solutions tenant.

JSON request

provisioning_region string A UUID identifying the Provisioning Region.
country string Two character ISO 3166 country code. The country have to be supported by the selected Provisioning Region
first_name string First name of the tenant. Maximum length is 50 characters.
last_name string Last name of the tenant. Maximum length is 50 characters.
email_address string Email address of the tenant.
locale string Locale in the form of XX_xx (language_territory)
company_name string Company name
address string Deprecated. Its value is accepted and will be automatically assigned into address_line fields. If the value contains multiple lines, the first line will go to the address_line1, the rest of lines will be joined and go to the address_line2.
address_line1 string First line of the address. Maximum length is 200 characters.
address_line2 string Second line of the address. Optional. Maximum length is 200 characters.
city string Max. length: 128
state string Depending on the selected country. Please check for valid values per country: https://msdn.microsoft.com/en-us/library/partnercenter/dn974938.aspx
zip_code string Validation depending on the selected country. See valid values per country: https://msdn.microsoft.com/en-us/library/partnercenter/dn974938.aspx
phone_number string Valid phone number.
domain_prefix string Sub-domain for the onmicrosoft.com domain ({prefix}.onmicrosoft.com). This domain will be used to access the account. Only alphanumeric (alphabetic and numeric) characters are allowed.
client_reference string An optional value to be filled by the client. This is usable to identify the created object by an client-side defined value. A use case is the ability to recover from an network-error during creation e.g. no response returned after creation of the tenant.

JSON response

object: Cloud Solutions Tenant

Two extra fields are returned upon creation: login and password. The password is only usable one time.

Sample

curl \
--request POST \
--user "{{api_username}}:{{api_key}}" \
--data '
    {
        "provisioning_region": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "country": "NL",
        "first_name": "John",
        "last_name": "Doe",
        "email_address": "john@example.com",
        "locale": "nl_NL",
        "company_name": "Johns inc.",
        "address": "Example street 13",
        "city": "Smallville",
        "state": "OV",
        "zip_code": "1234AB",
        "phone_number": "+31.612345678",
        "domain_prefix": "johnsinc",
        "client_reference": "#123",
    }
' \
"{{api_base_url}}/cloud-solutions-tenant" | python -m json.tool

/cloud-solutions-tenant/{id}

GET

Get detailed information about a tenant.

Request parameters

extended boolean Set to true if you need extended information (might be slower!).

JSON response

object: Cloud Solutions Tenant

When extended is true the response get extended with the values as returned by Microsoft: https://msdn.microsoft.com/en-us/library/partnercenter/mt146408.aspx

Possible errors

Sample

curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/cloud-solutions-tenant/{id}" | python -m json.tool