Skip to content

externalconnectors-external-list-authorizationsystems.md

Latest commit

 

History

History
266 lines (225 loc) · 11.1 KB

externalconnectors-external-list-authorizationsystems.md

File metadata and controls

266 lines (225 loc) · 11.1 KB
title List authorizationSystems
description List the authorizationSystem objects and their properties.
author mrudulahg01
ms.reviewer ciem_pm
ms.localizationpriority medium
ms.subservice entra-permissions-management
doc_type apiPageType
ms.date 08/01/2024

List authorizationSystems

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

[!INCLUDE permissions-management-retirement-note]

List the authorizationSystem objects onboarded to Permissions Management and their properties.

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

HTTP request

GET /external/authorizationSystems

Optional query parameters

This method supports the $filter, $orderby, and $skip 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 authorizationSystem objects in the response body.

Examples

Example 1: List authorization systems onboarded to Permissions Management

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/external/authorizationSystems

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/authorizationSystems",
  "value": [
    {
      "@odata.type": "#microsoft.graph.awsAuthorizationSystem",
      "id": "Mzc3NTk2MTMxNzc0",
      "authorizationSystemId": "377596131774",
      "authorizationSystemName": "staging",
      "authorizationSystemType": "AWS",
      "dataCollectionInfo@odata.context": "https://graph.microsoft.com/beta/$metadata#external/authorizationSystems('Mzc3NTk2MTMxNzc0')/microsoft.graph.awsAuthorizationSystem/dataCollectionInfo/$entity",
      "dataCollectionInfo": {
        "entitlements": {
          "@odata.type": "microsoft.graph.entitlementsDataCollection",
          "status": "offline",
          "lastCollectionDateTime": "2023-02-17T21:12:48Z",
          "permissionsModificationCapability":  "enabled"
        }
      }
    },
    {
      "@odata.type": "#microsoft.graph.awsAuthorizationSystem",
      "id": "OTU2OTg3ODg3NzM1",
      "authorizationSystemId": "956987887735",
      "authorizationSystemName": "development",
      "authorizationSystemType": "AWS",
      "dataCollectionInfo@odata.context": "https://graph.microsoft.com/beta/$metadata#external/authorizationSystems('OTU2OTg3ODg3NzM1')/microsoft.graph.awsAuthorizationSystem/dataCollectionInfo/$entity",
      "dataCollectionInfo": {
        "entitlements": {
          "@odata.type": "microsoft.graph.noEntitlementsDataCollection"
        }
      }
    },
    {
      "@odata.type": "#microsoft.graph.azureAuthorizationSystem",
      "id": "NTc1N2Y5NzAtYTcwMS00YTJkLThjZGItOTdjODU4MjE2MDg0",
      "authorizationSystemId": "5757f970-a701-4a2d-8cdb-97c858216084",
      "authorizationSystemName": "Microsoft Azure Sponsorship 2",
      "authorizationSystemType": "AZURE",
      "dataCollectionInfo@odata.context": "https://graph.microsoft.com/beta/$metadata#external/authorizationSystems('NTc1N2Y5NzAtYTcwMS00YTJkLThjZGItOTdjODU4MjE2MDg0')/microsoft.graph.azureAuthorizationSystem/dataCollectionInfo/$entity",
      "dataCollectionInfo": {
        "entitlements": {
          "@odata.type": "microsoft.graph.entitlementsDataCollection",
          "status": "online",
          "lastCollectionDateTime": "2023-03-17T21:12:48Z",
          "permissionsModificationCapability": "notConfigured"
        }
      }
    },
    {
      "@odata.type": "#microsoft.graph.gcpAuthorizationSystem",
      "id": "Y2FyYmlkZS1ib25zYWktMjA1MDE3",
      "authorizationSystemId": "carbide-bonsai-205017",
      "authorizationSystemName": "ck-staging",
      "authorizationSystemType": "GCP",
      "dataCollectionInfo@odata.context": "https://graph.microsoft.com/beta/$metadata#external/authorizationSystems('Y2FyYmlkZS1ib25zYWktMjA1MDE3')/microsoft.graph.gcpAuthorizationSystem/dataCollectionInfo/$entity",
      "dataCollectionInfo": {
        "entitlements": {
          "@odata.type": "microsoft.graph.entitlementsDataCollection",
          "status": "offline",
          "lastCollectionDateTime": "2023-02-17T21:12:48Z",
          "permissionsModificationCapability":  "noRecentDataCollected"
        }
      }
    }
  ],
  "@odata.nextLink": "https://graph.microsoft.com/beta/external/authorizationSystems?$skiptoken=MQ",
}

Example 2: Identify all the authorization systems that are online and have permissions modification capability enabled

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/external/authorizationSystems?$filter=dataCollectionInfo/entitlements/microsoft.graph.entitlementsDataCollection/permissionsModificationCapability eq 'enabled' and dataCollectionInfo/entitlements/microsoft.graph.entitlementsDataCollection/status eq 'online'

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

{  
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/authorizationSystems/$entity",  
  "value": [  
    {  
      "@odata.type": "#microsoft.graph.awsAuthorizationSystem",  
      "id": "OTU2OTg3ODg3NzM1",  
      "authorizationSystemId": "956987887735",  
      "authorizationSystemName": "development",  
      "authorizationSystemType": "AWS",  
      "dataCollectionInfo@odata.context": "https://graph.microsoft.com/beta/$metadata#external/authorizationSystems('OTU2OTg3ODg3NzM1')/microsoft.graph.awsAuthorizationSystem/dataCollectionInfo/$entity",  
      "dataCollectionInfo": {  
        "entitlements": {  
          "@odata.type": "microsoft.graph.entitlementsDataCollection",  
          "status": "online",  
          "lastCollectionDateTime": "2023-02-17T21:12:48Z",  
          "permissionsModificationCapability": "enabled"  
        }  
      }  
    },  
  ],  
  "@odata.nextLink": "https://graph.microsoft.com/beta/external/authorizationSystems?$filter=dataCollectionInfo%2fentitlements%2fmicrosoft.graph.entitlementsDataCollection%2fpermissionsModificationCapability+eq+%27enabled%27+and+dataCollectionInfo%2fentitlements%2fmicrosoft.graph.entitlementsDataCollection%2fstatus+eq+%27online%27&$skiptoken=MQ",  
}