Skip to content

crosstenantaccesspolicy-list-partners.md

Latest commit

 

History

History
267 lines (210 loc) · 8.65 KB

crosstenantaccesspolicy-list-partners.md

File metadata and controls

267 lines (210 loc) · 8.65 KB
title List partners
description Get a list of all partner configurations within a cross-tenant access policy.
author jkdouglas
ms.localizationpriority medium
ms.subservice entra-sign-in
doc_type apiPageType
ms.date 10/17/2024

List partners

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Get a list of all partner configurations within a cross-tenant access policy. You can also use the $expand parameter to list the user and group synchronization policy for all partner configurations.

[!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-read]

HTTP request

GET /policies/crossTenantAccessPolicy/partners

Optional query parameters

This method supports the $select and $expand OData query parameters 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 collection of crossTenantAccessPolicyConfigurationPartner objects in the response body.

Examples

Example 1: List all partner configurations within a cross-tenant access policy

The following example shows how to list all partner configurations within a cross-tenant access policy.

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/policies/crossTenantAccessPolicy/partners

C#

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

Go

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

Java

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

JavaScript

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

PHP

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

PowerShell

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

Python

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

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "tenantId": "123f4846-ba00-4fd7-ba43-dac1f8f63013",
      "inboundTrust": null,
      "isInMultiTenantOrganization": false,
      "automaticUserConsentSettings": {
        "inboundAllowed": null,
        "outboundAllowed": null
      },
      "b2bCollaborationInbound": null,
      "b2bCollaborationOutbound": null,
      "b2bDirectConnectOutbound": null,
      "b2bDirectConnectInbound": {
        "usersAndGroups": {
          "accessType": "allowed",
          "targets": [
            {
              "target": "AllUsers",
              "targetType": "user"
            }
          ]
        },
        "applications": {
          "accessType": "allowed",
          "targets": [
            {
              "target": "Office365",
              "targetType": "application"
            }
          ]
        }
      },
      "tenantRestrictions": 
      {
        "usersAndGroups": 
        {
          "accessType": "blocked",
          "targets": [
            {
              "target": "AllUsers",
              "targetType": "user"
            }
          ]
        },
        "applications": 
        {
          "accessType": "blocked",
          "targets": [
            {
              "target": "AllApplications",
              "targetType": "application"
            }
          ]
        }
      }
    }
  ]
}

Example 2: List the user and group synchronization policy for all partner configurations

The following example uses the $expand parameter to list the user and group synchronization policy for all partner configurations.

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/policies/crossTenantAccessPolicy/partners?$select=tenantId&$expand=identitySynchronization

C#

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

Go

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

Java

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

JavaScript

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

PHP

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

PowerShell

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

Python

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

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "tenantId": "9c5d131d-b1c3-4fc4-9e3f-c6557947d551",
      "identitySynchronization": {
        "tenantId": "9c5d131d-b1c3-4fc4-9e3f-c6557947d551",
        "displayName": "Fabrikam",
        "groupSyncInbound": {
          "isSyncAllowed": true
        },
        "userSyncInbound": {
          "isSyncAllowed": true
        }
      }
    }
  ]
}