Edit

Share via

Update multiTenantOrganizationMember

  • 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.

Update the properties of a tenant in a multi-tenant organization. Only owner tenants can call this API.

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.

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. Security Administrator is the least privileged role supported for this operation.

HTTP request

PATCH /tenantRelationships/multiTenantOrganization/tenants/{tenantId}

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Property Type Description
role multiTenantOrganizationMemberRole Role of the tenant in the multi-tenant organization. The possible values are: owner, member (default), unknownFutureValue. Optional.

Response

If successful, this method returns a 204 No Content response code.

Examples

The following example changes the role of a tenant in a multi-tenant organization from member to owner.

Request

PATCH https://graph.microsoft.com/beta/tenantRelationships/multiTenantOrganization/tenant/5036a0a0-a7a4-4933-9086-5dd54535dd6e
Content-Type: application/json

{
    "role": "owner"
}

Response

HTTP/1.1 204 No Content