Bewerken

Delen via


Create identitySynchronization

Namespace: microsoft.graph

Create a cross-tenant user synchronization policy for a partner-specific configuration.

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

Important

In delegated scenarios with work or school accounts where the signed-in user is acting on another user, they 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.

  • Teams Administrator - excluding identity synchronization settings
  • Security Administrator

HTTP request

PUT /policies/crossTenantAccessPolicy/partners/{id}/identitySynchronization

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 a JSON representation of the crossTenantIdentitySyncPolicyPartner object.

You can specify the following properties when you create a crossTenantIdentitySyncPolicyPartner.

Property Type Description
displayName String Display name for the cross-tenant user synchronization policy. Use the name of the partner Microsoft Entra tenant to easily identify the policy. Optional.
userSyncInbound crossTenantUserSyncInbound Determines whether users are synchronized from the partner tenant.

Response

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

Examples

Request

The following example shows a request.

PUT https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/partners/90e29127-71ad-49c7-9ce8-db3f41ea06f1/identitySynchronization
Content-Type: application/json

{
  "displayName": "Fabrikam",
  "userSyncInbound": {
    "isSyncAllowed": true
  }
}

Response

The following example shows the response.

HTTP/1.1 204 No Content