Export (0) Print
Expand All

TenantDetail

Updated: August 15, 2013

Applies To: Windows Azure AD Graph.

Overview

This topic provides descriptions of the properties of the TenantDetail entity type.

Windows Azure AD Graph exposes metadata that describes the directory as an Entity Data Model (EDM) using Conceptual Schema Definition Language (CSDL). You can view the metadata exposed for your tenant by performing an HTTP GET from the following URL: https://graph.windows.net/yourTenantDomain/$metadata?api-version=2013-04-05. Replace yourTenantDomain with the domain of your tenant; for example, https://graph.windows.net/contoso.onmicrosoft.com/$metadata?api-version=2013-04-05. For more information about the EDM and CSDL, see Entity Data Model.

Properties

The TenantDetail entity type is defined as follows:

Namespace: Microsoft.WindowsAzure.ActiveDirectory

Base type: DirectoryObject

Type Properties

Name Type Notes Read/Write Key Description

assignedPlans

Collection(AssignedPlan)

R

The collection of service plans associated with the tenant.

authorizedServiceInstances

Collection(Edm.String)

R

city

Edm.String

R

companyLastDirSyncTime

Edm.DateTime

R

The time and date at which the tenant was last synced with the on-premise directory.

country

Edm.String

R

countryLetterCode

Edm.String

R

dirSyncEnabled

Edm.Boolean

R

Indicates whether this object was synced from the on-premises directory.

displayName

Edm.String

R

The display name for the tenant.

marketingNotificationEmails

Collection(Edm.String)

RW

objectId

Edm.String

Immutable, not nullable, unique

R

Yes

The unique identifier for the tenant. Inherited from DirectoryObject.

objectType

Edm.String

R

A string that identifies the object type. For tenants the value is always “Company”. Inherited from DirectoryObject.

postalCode

Edm.String

R

preferredLanguage

Edm.String

R

provisionedPlans

Collection(ProvisionedPlan)

R

provisioningErrors

Collection(ProvisioningError)

R

state

Edm.String

R

street

Edm.String

R

technicalNotificationMails

Collection(Edm.String)

RW

telephoneNumber

Edm.String

R

tenantType

Edm.String

R

verifiedDomains

Collection(VerifiedDomain)

Required

R

The collection of domains associated with this tenant.

noteNote
TenantDetail also inherits the manager, directReports, member, and memberOf navigation properties from DirectoryObject; however, none of these properties are valid for tenants. If a request for any of these properties is sent, a 400 Bad Request response is returned.

For information about the primitive types exposed by the EDM, see Entity Data Model: Primitive Data Types.

Addressing

The following list shows how to address the tenant resource set, which spans all the tenants in the directory and how to address an individual tenant. The examples in the list use the tenant domain to address the tenant. For other ways of addressing the tenant, see Addressing Entities and Operations in the Graph.

  • Resource Set: https://graph.windows.net/<tenantDomain>/tenantDetails?api-version=<version>. For example, https://graph.windows.net/contoso.onmicrosoft.com/tenantDetails?api-version=2013-04-05.

  • Tenant: https://graph.windows.net/<tenantDomain>/tenantDetails/<objectId>?api-version=<version>. For example, https://graph.windows.net/contoso.onmicrosoft.com/tenantDetails/12345678-9abc-def0-1234-56789abcde?api-version=2013-04-05.

noteNote
Tenants can also be addressed as generic directory objects by replacing “tenantDetails” with “directoryObjects” in the URI.

For more comprehensive information about querying directory objects, see Windows Azure AD Graph Common Queries and Windows Azure AD Graph Differential Query.

Supported Operations and Permissions

The following operations are supported on tenants (the HTTP method used for each is in parentheses): Read (GET) and Update (PATCH); however, only the marketingNotificationMails and technicalNotificationMails properties can be updated using Windows Azure AD Graph.

The service principal that represents an application must be in an administrator role that has permissions to modify tenant details to send PATCH requests. It must be in a role that has permission to read tenant details to send GET requests. For more information about roles in Windows Azure AD Graph, see Windows Azure AD Graph and Role-Based Access Control.

Remarks

  • You cannot create or delete tenants using Windows Azure AD Graph.

  • Only the marketingNotificationMails and technicalNotificationMails properties can be updated using Windows Azure AD Graph.

  • Query filter expressions are not supported on tenants.

See Also

Show:
© 2014 Microsoft