Get multiTenantOrganizationPartnerConfigurationTemplate
Namespace: microsoft.graph
Get the cross-tenant access policy template with inbound and outbound partner configuration 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 |
In delegated scenarios with work or school accounts, the signed-in user 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.
- Security Reader
- Global Reader
Signed-in users are able to read basic attributes of a multitenant organization, and of the multitenant organization member tenants, without being assigned the Security Reader or Global Reader roles.
HTTP request
GET /policies/crossTenantAccessPolicy/templates/multiTenantOrganizationPartnerConfiguration
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. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a multiTenantOrganizationPartnerConfigurationTemplate object in the response body.
Examples
The following example gets the partner configuration settings of the template.
Request
GET https://graph.microsoft.com/v1.0/policies/crossTenantAccessPolicy/templates/multiTenantOrganizationPartnerConfiguration
Response
The following example response shows the unconfigured (or reset) state of the cross-tenant access policy template for partner configuration 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/multiTenantOrganizationPartnerConfiguration/$entity",
"id": "75b1889b-6f42-4cc5-8e62-e774b8db243c",
"templateApplicationLevel": "newPartners,existingPartners",
"inboundTrust": null,
"b2bCollaborationOutbound": null,
"b2bCollaborationInbound": null,
"b2bDirectConnectOutbound": null,
"b2bDirectConnectInbound": null,
"automaticUserConsentSettings": {
"inboundAllowed": null,
"outboundAllowed": null
}
}
The following example response shows a configured state of the cross-tenant access policy template for partner configuration settings, after inbound trust and automatic redemption have been configured.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#policies/crossTenantAccessPolicy/templates/multiTenantOrganizationPartnerConfiguration/$entity",
"id": "8d253b1b-1798-434a-8e77-bec3774d1512",
"templateApplicationLevel": "newPartners,existingPartners",
"b2bCollaborationOutbound": null,
"b2bCollaborationInbound": null,
"b2bDirectConnectOutbound": null,
"b2bDirectConnectInbound": null,
"inboundTrust": {
"isMfaAccepted": true,
"isCompliantDeviceAccepted": true,
"isHybridAzureADJoinedDeviceAccepted": true
},
"automaticUserConsentSettings": {
"inboundAllowed": true,
"outboundAllowed": true
}
}