Get identityApiConnector

Namespace: microsoft.graph

Read the properties of an identityApiConnector object.


One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) APIConnectors.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application APIConnectors.ReadWrite.All

The work or school account needs to belong to one of the following roles:

  • Global administrator
  • External Identity User Flow administrator

HTTP request

GET /identity/apiConnectors/{identityApiConnectorId}

Optional query parameters

You can use $expand to expand specific properties that are not expanded by default. For more information, see OData query parameters.

Request headers

Name Description
Authorization Bearer {token}. Required.

Request body

Do not supply a request body for this method.


If successful, this method returns a 200 OK response code and an identityApiConnector object in the response body.



The following is an example of the request.



The following is an example of the response.

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

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

    "@odata.context": "$metadata#identity/apiConnectors/$entity",
    "displayName": "Test API",
    "targetUrl": "",
    "authenticationConfiguration": {
        "@odata.type": "#microsoft.graph.basicAuthentication",
        "username": "<USERNAME>",
        "password": "******"