Tenants - List
Gets the tenants for your account.
GET https://management.azure.com/tenants?api-version=2020-01-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
api-version
|
query | True |
|
The API version to use for the operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK - Returns an array of tenants. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Get all tenants.
Sample Request
GET https://management.azure.com/tenants?api-version=2020-01-01
Sample Response
{
"value": [
{
"id": "/tenants/a70a1586-9c4a-4373-b907-1d310660dbd1",
"tenantId": "a70a1586-9c4a-4373-b907-1d310660dbd1",
"countryCode": "US",
"displayName": "Test_Test_aad50",
"domains": [
"aad50.ccsctp.net"
],
"tenantCategory": "ManagedBy",
"defaultDomain": "aad50.ccsctp.net",
"tenantType": "AAD"
},
{
"id": "/tenants/83abe5cd-bcc3-441a-bd86-e6a75360cecc",
"tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
"countryCode": "US",
"displayName": "Contoso Corp.",
"domains": [
"auxteststagemanual.ccsctp.net"
],
"tenantCategory": "Home",
"defaultDomain": "auxteststagemanual.ccsctp.net",
"tenantType": "AAD"
},
{
"id": "/tenants/daea2e9b-847b-4c93-850d-2aa6f2d7af33",
"tenantId": "daea2e9b-847b-4c93-850d-2aa6f2d7af33",
"countryCode": "US",
"displayName": "TEST_TEST_RDV",
"domains": [
"rdvmohoro.ccsctp.net",
"rdvmohoro.mail.ccsctp.net",
"rdvmohoro.com"
],
"tenantCategory": "ProjectedBy",
"defaultDomain": "rdvmohoro.ccsctp.net",
"tenantType": "AAD",
"tenantBrandingLogoUrl": "logo1.logo.rdvmohoro.com"
}
],
"nextLink": "..."
}
Definitions
Tenant |
Category of the tenant. |
Tenant |
Tenant Id information. |
Tenant |
Tenant Ids information. |
TenantCategory
Category of the tenant.
Name | Type | Description |
---|---|---|
Home |
|
|
ManagedBy |
|
|
ProjectedBy |
|
TenantIdDescription
Tenant Id information.
Name | Type | Description |
---|---|---|
country |
|
Country/region name of the address for the tenant. |
countryCode |
|
Country/region abbreviation for the tenant. |
defaultDomain |
|
The default domain for the tenant. |
displayName |
|
The display name of the tenant. |
domains |
|
The list of domains for the tenant. |
id |
|
The fully qualified ID of the tenant. For example, /tenants/00000000-0000-0000-0000-000000000000. |
tenantBrandingLogoUrl |
|
The tenant's branding logo URL. Only available for 'Home' tenant category. |
tenantCategory |
Category of the tenant. |
|
tenantId |
|
The tenant ID. For example, 00000000-0000-0000-0000-000000000000. |
tenantType |
|
The tenant type. Only available for 'Home' tenant category. |
TenantListResult
Tenant Ids information.
Name | Type | Description |
---|---|---|
nextLink |
|
The URL to use for getting the next set of results. |
value |
An array of tenants. |