Skip to content

crosstenantidentitysyncpolicypartner-update.md

Latest commit

 

History

History
102 lines (75 loc) · 3.57 KB

crosstenantidentitysyncpolicypartner-update.md

File metadata and controls

102 lines (75 loc) · 3.57 KB
title Update crossTenantIdentitySyncPolicyPartner
description Update the user and group synchronization policy of a partner-specific configuration.
author rolyon
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type apiPageType
ms.date 10/17/2024

Update crossTenantIdentitySyncPolicyPartner

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Update the user and group synchronization policy of a partner-specific configuration.

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.

[!INCLUDE permissions-table]

[!INCLUDE rbac-xtap-apis-write]

HTTP request

PATCH /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

[!INCLUDE table-intro]

Property Type Description
displayName String Display name for the cross-tenant user and group synchronization policy. Generally, this should be the tenant name of the partner Microsoft Entra organization. Optional.
groupSyncInbound crossTenantGroupSyncInbound Determines whether groups can be synchronized from the partner tenant. false causes any current group synchronization from the source tenant to the target tenant to stop. This property has no impact on existing groups that have already been synchronized.
userSyncInbound crossTenantUserSyncInbound Determines whether users can be synchronized from the partner tenant. false causes any current user synchronization from the source tenant to the target tenant to stop. This property has no impact on existing users who have already been synchronized.

Response

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

Examples

Request

The following example shows a request.

HTTP

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

{
  "groupSyncInbound": {
    "isSyncAllowed": true
  },
  "userSyncInbound": {
    "isSyncAllowed": true
  }
}

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

HTTP/1.1 204 No Content