Skip to content

Latest commit

 

History

History
362 lines (282 loc) · 14.8 KB

File metadata and controls

362 lines (282 loc) · 14.8 KB
title Update crossTenantAccessPolicyConfigurationDefault
description Update the default configuration of a cross-tenant access policy.
author jkdouglas
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type apiPageType
ms.date 10/17/2024

Update crossTenantAccessPolicyConfigurationDefault

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Update the default configuration of a cross-tenant access policy.

[!INCLUDE national-cloud-support]

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

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
appServiceConnectInbound crossTenantAccessPolicyAppServiceConnectSetting Defines your default configuration for inbound app service connect settings that control which applications can connect across tenant boundaries.
b2bCollaborationInbound crossTenantAccessPolicyB2BSetting Defines your default configuration for users from other organizations accessing your resources via Microsoft Entra B2B collaboration.
b2bCollaborationOutbound crossTenantAccessPolicyB2BSetting Defines your default configuration for users in your organization going outbound to access resources in another organization via Microsoft Entra B2B collaboration.
b2bDirectConnectInbound crossTenantAccessPolicyB2BSetting Defines your default configuration for users from other organizations accessing your resources via Microsoft Entra B2B direct connect.
b2bDirectConnectOutbound crossTenantAccessPolicyB2BSetting Defines your default configuration for users in your organization going outbound to access resources in another organization via Microsoft Entra B2B direct connect.
inboundTrust crossTenantAccessPolicyInboundTrust Determines the default configuration for trusting other Conditional Access claims from external Microsoft Entra organizations.
invitationRedemptionIdentityProviderConfiguration defaultInvitationRedemptionIdentityProviderConfiguration Defines the priority order based on which an identity provider is chosen during invitation redemption.
m365CollaborationInbound crossTenantAccessPolicyM365CollaborationInboundSetting Defines your default configuration for inbound Microsoft 365 collaboration settings that determine which users from other organizations can collaborate with your organization using Microsoft 365 apps.
m365CollaborationOutbound crossTenantAccessPolicyM365CollaborationOutboundSetting Defines your default configuration for outbound Microsoft 365 collaboration settings that determine which users in your organization can collaborate with other organizations using Microsoft 365 apps.
tenantRestrictions crossTenantAccessPolicyTenantRestrictions Defines the default tenant restrictions configuration for users in your organization who access an external organization on your network or devices.

Response

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

Examples

Example 1: Block outbound B2B collaboration for a group of users

Request

PATCH https://graph.microsoft.com/beta/policies/crossTenantAccessPolicy/default
Content-Type: application/json

{
  "b2bCollaborationOutbound":
  {
    "usersAndGroups":
    {
      "accessType": "blocked",
      "targets": [
        {
          "target": "0be493dc-cb56-4a53-936f-9cf64410b8b0",
          "targetType": "group"
        }
      ]
    },
    "applications":
    {
      "accessType": "blocked",
      "targets": [
        {
          "target": "AllApplications",
          "targetType": "application"
        }
      ]
    }
  }
}

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

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

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

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

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

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

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


Response

HTTP/1.1 204 No Content

Example 2: Update default invitation redemption configuration

Request

PATCH https://graph.microsoft.com/beta/policies/crossTenantAccessPolicy/default
Content-Type: application/json

{
  "invitationRedemptionIdentityProviderConfiguration": { 
    "primaryIdentityProviderPrecedenceOrder": [ 
        "externalFederation", 
        "azureActiveDirectory", 
        "socialIdentityProviders" 
    ], 
    "fallbackIdentityProvider": "defaultConfiguredIdp" 
  } 
}

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

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

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

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

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

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

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


Response

HTTP/1.1 204 No Content

Example 3: Disallow Microsoft accounts as an option for redeeming B2B invitations

Request

PATCH https://graph.microsoft.com/beta/policies/crossTenantAccessPolicy/default
Content-Type: application/json

{
  "invitationRedemptionIdentityProviderConfiguration": { 
    "primaryIdentityProviderPrecedenceOrder": [ 
        "externalFederation", 
        "azureActiveDirectory", 
        "socialIdentityProviders" 
    ], 
    "fallbackIdentityProvider": "emailOneTimePasscode" 
  } 
}

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

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

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

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

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

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

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


Response

HTTP/1.1 204 No Content

Example 4: Configure Microsoft 365 collaboration settings

The following example shows how to configure the default cross-tenant access policy to allow inbound Microsoft 365 collaboration for all users.

Request

The following example shows a request.

PATCH https://graph.microsoft.com/beta/policies/crossTenantAccessPolicy/default
Content-Type: application/json

{
  "m365CollaborationInbound": {
    "users": {
      "accessType": "allowed",
      "targets": [
        {
          "target": "AllUsers",
          "targetType": "user"
        }
      ]
    }
  }
}

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

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

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

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

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

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

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


Response

The following example shows the response.

HTTP/1.1 204 No Content