Edit

Use Postman with the Microsoft Graph connectors API

  • Article

Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so that you can create better APIs faster.

This article describes how you can use the Microsoft Graph connectors API with Postman.

Prerequisites

  • Either a Microsoft account or work or school account.
  • Access to a Microsoft 365 developer tenant. If you don't have one, you can sign up for the Microsoft 365 Developer Program to get a free developer subscription.

Step 1: Fork the Microsoft Graph Postman collection

To use the Postman collection, you need to fork it into your Postman workspace. Do this from a web browser.

  1. Go to Postman and sign up. If you already have a Postman account, you can sign in.

  2. After you sign in, go to the following URL: https://www.postman.com/microsoftgraph/workspace/microsoft-graph/collection/455214-085f7047-1bec-4570-9ed0-3a7253be148 and select the Microsoft Graph collection.

  3. Select the three dots to the right, and then select Create a fork.

    Screenshot showing the Microsoft Graph collection in Postman and the option to create a fork

  4. In the dialog that opens, enter a label to identify your fork. In the Workspace dropdown menu, select My Workspace, and then select Fork Collection.

    Screenshot showing the Fork collection dialog in Postman and the options to enter a label, and select My Workspace

  5. Go to Workspaces > My Workspace to see the fork that you created. You can find the Microsoft Graph connectors folder under Application.

    Screenshot of the My Workspace section in Postman, showing the Microsoft Graph collection forked

Step 2: Download the Postman Agent (optional - Postman web browser only)

To use this Postman collection in your web browser, download the Postman Desktop Agent.

You can't use Postman for the web without this due to CORS restrictions in the web browser: "The maximum number of connection resources per Microsoft 365 tenant."

You don't need the agent if you're using the Postman for Windows app. If you open Postman for Windows, you see this collection in your workspace.

Step 3: Create an Azure AD application

To use this collection in your own developer tenant, create an Azure Active Directory (Azure AD) application and give it the appropriate permissions for the requests that you want to call.

  1. Sign in to the Microsoft Entra admin center.
  2. Expand the Identity menu > select Applications > App registrations > New registration.
  3. Set the Application name to Parts Inventory.
  4. Set the Redirect URI to https://oauth.pstmn.io/v1/browser-callback.
  5. Select Register.
  6. On the left menu, select API Permissions.
  7. On the horizontal menu, select Add a permission > Microsoft Graph > Delegated Permissions or Application Permissions.
  8. Start typing External and choose the delegated or application permissions necessary for the API you are calling. Search for Search Permissions in the Graph Permissions reference for more details.
  9. Select Add permissions.
  10. On the horizontal menu, select Grant admin consent for, and then select Yes.
  11. On the left menu, select Overview. From here, you can get the application (client) ID and directory (tenant) ID. You'll need these in step 4.
  12. On the left menu, select Certificates and secrets.
  13. Select New client secret, enter a description, and then select Add. Copy the new client secret value; you'll need this in step 4.

The application now has two permissions configured. ExternalItem.ReadWrite.All is added as a delegated permission, which is a permission that requires a signed-in user. The application can read/write external items on behalf of the user. ExternalItem.ReadWrite.All is added as an application permission, which is a permission that does not require a signed-in user. The application can read/write external items on its own behalf.

Step 4: Configure authentication

In this step, you set up the environment variables in Postman that you use to retrieve an access token.

  1. Select the Microsoft Graph tab and go to the Variables section.

    Screenshot of the Microsoft Graph connectors API tab and the Variables section

  2. In the Variables section, provide the required information by using the information from step 3:

    • Set the current value of tenant to the directory (tenant) ID value from step 3.15.
    • Set the current value of client_id to the application (client) ID value from step 3.15.
    • Set the current value of client_secret to the client secret value from step 3.17.
    • Set the current value of userName to admin@xxxxxxx.onmicrosoft.com.
    • Set the current value of password to tenant admin password.

    Screenshot showing the selected Variables

  3. Select Save / Update.

Step 5: Get an authentication token

You need to get an access token because this is the first time you are running a request as an application authentication flow. Get the app access token by making the following POST request:

Screenshot of the Get app access token section

The following example shows how to get an access token with a shared secret:

POST /{{tenant}}/oauth2/v2.0/token HTTP/1.1 //Line breaks for clarity
Host: login.microsoftonline.com
Content-Type: application/x-www-form-urlencoded

client_id={{client_id}} 
&scope=https%3A%2F%2Fgraph.microsoft.com%2F.default 
&client_secret={{client_secret}} 
&grant_type=client_credentials

The following example shows a successful response:

{ 
    "token_type": "Bearer", 
    "expires_in": 3599, 
    "ext_expires_in": 3599, 
    "access_token": "eyJ0eXAiOiJKV1QiLCJu… " 
}

Note

You are using the client credential flow here. Be sure to get an app access token and not a user access token.

Step 6: Create a new connection

A connection is a logical container for your external data that you can manage as a single unit. Choose a connection name, description, and ID. Get the necessary details from the admin to connect to the data source and provide a mechanism to authorize against the content source when setting up the connection. You can use the Microsoft Graph SDK and APIs to program your connector setup. If you want to store credentials, you can use Azure Key Vault.

POST /external/connections

The following is an example of the request.

POST https://graph.microsoft.com/beta/external/connections 
Content-type: application/json 

{ 
  "id": "contosotasks", 
  "name": "Contoso Tasks", 
  "description": "Connection to index Contoso task management system" 
}

The following is an example of the response.

HTTP/1.1 201 Created 
Content-type: application/json 
 
{ 
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#connections/$entity", 
    "id": "contosotasks", 
    "name": "Contoso Tasks", 
    "description": "Connection to index Contoso task management system", 
    "state": null, 
    "configuration": { 
        "authorizedApps": [ 
            "a47b35b7-6271-4e6d-9e27-2450a8b9c6b6" 
        ] 
    } 
}

The following is a screenshot of the Create connection section.

Screenshot of the Create connection section

Step 7: Register connection schema

The connection schema determines how your content is used in various Microsoft Graph experiences. The schema is a flat list of all the properties that you plan to add to the connection along with their attributes, labels, and aliases. You must register the schema before adding items into the connection.

POST /external/connections/{id}/schema

The following is an example of the request.

POST https://graph.microsoft.com/beta/external/connections/contosotasks/schema 
Content-type: application/json 
Prefer: respond-async 

{ 
  "baseType": "microsoft.graph.externalItem", 
  "properties": [ 
    { 
"name": "title", 
      "type": "String", 
      "isSearchable": "true", 
"isQueryable": "true", 
      "isRetrievable": "true", 
      "labels": [ 
        "title" 
      ] 
    }, 
    { 
"aliases": "creator", 
      "name": "createdBy", 
      "type": "String", 
      "isSearchable": "true", 
"isQueryable": "true", 
      "isRetrievable": "false", 
"isRefinable": "false", 
      "labels": [ 
        "createdBy" 
      ] 
    }, 
    { 
"aliases": "editedDate", 
      "name": "lastEditedDate", 
      "type": "DateTime", 
      "isSearchable": "false", 
"isQueryable": "true", 
      "isRetrievable": "true", 
"isRefinable": "true", 
      "labels": [ 
   "lastModifiedDateTime" 
] 
    } 
  ] 
}

The following is an example of the response.

HTTP/1.1 202 Accepted 
Location: https://graph.microsoft.com/beta/external/connections/contosotasks/operations/616bfeed-666f-4ce0-8cd9-058939010bfc

Note

Registering connection schema is an asynchronous operation, so do not ingest items into the connection until the connection schema is in the Completed state. To check connection schema status, execute the following request:

GET /external/connections/contosotasks/operations/616bfeed-666f-4ce0-8cd9-058939010bfc

The following is another example of the request.

Request 
GET https://graph.microsoft.com/beta/external/connections/operations/616bfeed-666f-4ce0-8cd9-058939010bfc

The following is another example of the response.

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

{
    @odata.context":"https://graph.microsoft.com/beta/$metadata#external/connections('coursecatalog')/operations/$entity", 
    "id": "aa9186d2-893c-4361-ca51-431d88fa45d8", 
    "name": "Contoso Tasks", 
    "status": "inprogress", 
    "error": null  
}

The following is a screenshot of the Get connection operation status section.

Screenshot of the Get operation status section showing status in progress

After the connection schema operation status changes from InProgress to Completed, you can ingest items for the connection.

After the connection state changes from draft to ready, you can ingest items into the current connection.

Step 8: Add external group member (optional)

If your external service uses non-Azure AD access control lists (ACLs), sync those permissions.

External groups (along with Azure Active Directory users and groups) are used to set permissions on externalItems added to a Microsoft Graph connection. For details, see externalGroup.

This is an example of a request.

POST https://graph.microsoft.com/beta/external/connections/contosotasks/groups/31bea3d537902000/members 
Content-Type: application/json 
 
{ 
  "@odata.type": "#microsoft.graph.externalGroupMember", 
  "id": "1431b9c38ee647f6a", 
  "type": "group", 
  "identitySource": "external" 
}

This is an example of the response.

HTTP/1.1 201 Created 
Content-Type: application/json 

{ 
  "@odata.type": "#microsoft.graph.externalGroupMember", 
  "id": "14m1b9c38qe647f6a", 
  "type": "group", 
  "identitySource": "external" 
}

Step 9: Ingest Items

After you create a connection, you can add your content. Each item from your data source must be represented as an externalItem in Microsoft Graph with a unique item ID. This ID is used to create, update, or delete the item from Microsoft Graph. You can use the primary key from your data source as the itemId or derive it from one or more fields. An externalItem has three key components: access control list, properties, and content.

If you have binary files, you must parse to get the metadata and a text version of the content. If you have non-text content such as a PDF or BMP file, you must use object character recognition to convert content to text.

You are responsible for converting your source permissions to grant or deny. Deny takes higher precedence over grant.

The following is an example of a request.

PUT https://graph.microsoft.com/beta/external/connections/contosohr/items/TSP228082938 
Content-type: application/json 

{ 
  "@odata.type": "microsoft.graph.externalItem", 
  "acl": [ 
    { 
      "type": "user", 
      "value": "e811976d-83df-4cbd-8b9b-5215b18aa874", 
      "accessType": "grant", 
      "identitySource": "azureActiveDirectory" 
    }, 
    { 
      "type": "group", 
      "value": "14m1b9c38qe647f6a", 
      "accessType": "deny", 
      "identitySource": "external" 
    } 
  ], 
  "properties": { 
    "ticketID": "1158", 
    "priority": 1, 
    "title": "Filter design", 
  }, 
  "content": { 
    "value": "Build filtering capability by...", 
    "type": "text" 
  } 
}

The following is an example of a successful response.

HTTP/1.1 200 OK

Error handling

For details about how to resolve errors, see Resolve Microsoft Graph authorization errors.

See also