Edit

Share via

crossTenantAccessPolicy resource type

  • Article

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents the base policy in the directory for cross-tenant access settings.

Inherits from tenantRelationshipAccessPolicyBase.

Methods

Method Return type Description
Get crossTenantAccessPolicy Read the properties and relationships of a crossTenantAccessPolicy object.
Update crossTenantAccessPolicy Update the properties of a crossTenantAccessPolicy object.

Properties

Property Type Description
displayName String The display name of the cross-tenant access policy. Inherited from policyBase.
allowedCloudEndpoints String collection Used to specify which Microsoft clouds an organization would like to collaborate with. By default, this value is empty. Supported values for this field are: microsoftonline.com, microsoftonline.us, and partner.microsoftonline.cn.
definition (deprecated) String The raw JSON definition of the cross-tenant access policy. Deprecated. Do not use.

Relationships

Relationship Type Description
default crossTenantAccessPolicyConfigurationDefault Defines the default configuration for how your organization interacts with external Microsoft Entra organizations.
partners crossTenantAccessPolicyConfigurationPartner collection Defines partner-specific configurations for external Microsoft Entra organizations.
templates policyTemplate Represents the base policy in the directory for multi-tenant organization settings.

JSON representation

The following JSON representation shows the resource type. The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.crossTenantAccessPolicy",
  "displayName": "String",
  "definition": "String",
  "allowedCloudEndpoints": ["String"]
}