Edit

Share via

multiTenantOrganization resource type

  • Article

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Defines an organization with more than one instance of Microsoft Entra ID. A multitenant organization enables multiple tenants to collaborate like a single entity.

There can only be one multitenant organization per active tenant. It is not possible to be part of multiple multitenant organizations.

Methods

Method Return type Description
Create multiTenantOrganization Create a new multitenant organization.
Get multiTenantOrganization Get properties of the multitenant organization.
Update multiTenantOrganization Update the properties of a multitenant organization.

Properties

Property Type Description
createdDateTime DateTimeOffset Date when multitenant organization was created. Read-only.
description String Description of the multitenant organization.
displayName String Display name of the multitenant organization.
id String Tenant-specific object ID for the multitenant organization object. It is automatically generated when a multitenant organization object is created and stored in the local tenant. This ID is tenant-specific and doesn't match the object IDs of the same multitenant organization in other tenants. Read-only. Inherited from entity.
state multiTenantOrganizationState State of the multitenant organization. The possible values are: active, inactive, unknownFutureValue. active indicates the multitenant organization is created. inactive indicates the multitenant organization isn't created. Read-only.

Relationships

Relationship Type Description
joinRequest multiTenantOrganizationJoinRequestRecord Defines the status of a tenant joining a multitenant organization.
tenants multiTenantOrganizationMember collection Defines tenants added to a multitenant organization.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.multiTenantOrganization",
  "id": "String (identifier)",
  "createdDateTime": "String (timestamp)",
  "displayName": "String",
  "description": "String",
  "state": "String"
}