Get multiTenantOrganizationIdentitySyncPolicyTemplate
Namespace: microsoft.graph
Get the cross-tenant access policy template with user synchronization settings for 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) | Policy.Read.All | Policy.ReadWrite.CrossTenantAccess |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Policy.Read.All | Policy.ReadWrite.CrossTenantAccess |
The signed-in user must also be assigned at least one of the following directory roles:
- Security Reader
- Global Reader
HTTP request
GET /policies/crossTenantAccessPolicy/templates/multiTenantOrganizationIdentitySynchronization
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. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a multiTenantOrganizationIdentitySyncPolicyTemplate object in the response body.
Examples
The following example gets the user synchronization settings of the template.
Request
GET https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/templates/multiTenantOrganizationIdentitySynchronization
Response
The following example response shows the unconfigured (or reset) state of the cross-tenant access policy template for user synchronization settings for multitenant organization tenants.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#policies/crossTenantAccessPolicy/templates/multiTenantOrganizationIdentitySynchronization/$entity",
"templateApplicationLevel": "newPartners,existingPartners",
"id": "0e7aad84-cb46-4b8e-a881-522ef25939f1",
"userSyncInbound": {
"isSyncAllowed": null
}
}
The following example response shows a configured state of the cross-tenant access policy template for user synchronization settings, after inbound user synchronization has been configured.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#policies/crossTenantAccessPolicy/templates/multiTenantOrganizationIdentitySynchronization/$entity",
"id": "e1a11ff3-01f1-4c48-9784-b9d931571474",
"templateApplicationLevel": "newPartners,existingPartners",
"userSyncInbound": {
"isSyncAllowed": true
}
}
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