Create multiTenantOrganization
Namespace: microsoft.graph
Create a new multitenant organization. By default, the creator tenant becomes an owner tenant upon successful creation. Only owner tenants can manage a 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.ReadWrite.All | Not available. |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | MultiTenantOrganization.ReadWrite.All | Not available. |
The signed-in user must also be assigned at least the Security Administrator directory role.
HTTP request
PUT /tenantRelationships/multiTenantOrganization
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. |
Content-Type | application/json. Required. |
Request body
In the request body, supply a JSON representation of the multiTenantOrganization object.
You can specify the following properties when creating a multiTenantOrganization.
Property | Type | Description |
---|---|---|
displayName | String | Display name of the multitenant organization. Required. |
description | String | Description of the multitenant organization. Optional. |
Response
If successful, this method returns a 201 Created
response code and a multiTenantOrganization object in the response body.
Examples
The following example creates a new multitenant organization.
Request
PUT https://graph.microsoft.com/v1.0/tenantRelationships/multiTenantOrganization
Content-Type: application/json
{
"displayName": "Contoso organization",
"description": "Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank"
}
Response
HTTP/1.1 201 Created
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"
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for