Get multiTenantOrganization

Namespace: microsoft.graph

Get properties of the multitenant organization.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) MultiTenantOrganization.ReadBasic.All MultiTenantOrganization.ReadWrite.All, MultiTenantOrganization.Read.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application MultiTenantOrganization.Read.All MultiTenantOrganization.ReadWrite.All

Important

In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.

  • Security Reader
  • Global Reader

Signed-in users are able to read basic attributes of a multitenant organization, and of the multitenant organization member tenants, without being assigned the Security Reader or Global Reader roles.

HTTP request

GET /tenantRelationships/multiTenantOrganization

Optional query parameters

This method supports the $select OData query parameter to help customize the response. For general information, see OData query parameters.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a multiTenantOrganization object in the response body.

Examples

The following example gets properties of the multitenant organization.

Request

GET https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#tenantRelationships/multiTenantOrganization/$entity",
    "id": "6d8b39e5-039a-4034-bf3a-e0b4f8cd60b6",
    "createdDateTime": "2023-05-26T22:05:23Z",
    "displayName": "Contoso organization",
    "description": "Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank",
    "state": "active"
}

The following response shows when the requesting tenant is not part of any multitenant organization.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "createdDateTime": null,
    "displayName": null,
    "description": null,
    "state": "inactive"
}