Edit

Update tenantGovernanceSetting

Namespace: microsoft.graph

Update the canReceiveInvitations property of the tenantGovernanceSetting singleton. This property controls whether the tenant can receive governance invitations.

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) TenantGovernance-Setting.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Not supported. Not supported.

Important

For delegated access using work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role. Tenant Governance Administrator is the least privileged role supported for this operation.

HTTP request

PATCH /directory/tenantGovernance/settings

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
canReceiveInvitations Boolean Indicates whether the tenant can receive governance invitations. When set to false, the tenant can't receive new governance invitations. When set to true, other tenants can send your tenant invitations by providing your tenant ID or domain name. This setting is disabled by default. Required.

Response

If successful, this method returns a 200 OK response code and an updated microsoft.graph.tenantGovernanceSetting object in the response body.

Examples

Request

The following example shows a request.

PATCH https://graph.microsoft.com/v1.0/directory/tenantGovernance/settings
Content-Type: application/json

{
  "canReceiveInvitations": true
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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

{
  "@odata.type": "#microsoft.graph.tenantGovernanceSetting",
  "isRelatedTenantsEnabled": true,
  "canReceiveInvitations": true
}