Tutorial: Configure Postman for automatic user provisioning

This tutorial describes the steps you need to perform in both Postman and Microsoft Entra ID to configure automatic user provisioning. When configured, Microsoft Entra ID automatically provisions and de-provisions users and groups to Postman using the Microsoft Entra provisioning service. For important details on what this service does, how it works, and frequently asked questions, see Automate user provisioning and deprovisioning to SaaS applications with Microsoft Entra ID.

Supported capabilities

  • Create users in Postman.
  • Remove users in Postman when they do not require access anymore.
  • Keep user attributes synchronized between Microsoft Entra ID and Postman.
  • Provision groups and group memberships in Postman.
  • Single sign-on to Postman (recommended).

Prerequisites

The scenario outlined in this tutorial assumes that you already have the following prerequisites:

  • A Microsoft Entra tenant.
  • A user account in Microsoft Entra ID with permission to configure provisioning (for example, Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator).
  • A Postman tenant on the Enterprise plan.
  • A user account in Postman with Admin permissions.

Step 1: Plan your provisioning deployment

  1. Learn about how the provisioning service works.
  2. Determine who will be in scope for provisioning.
  3. Determine what data to map between Microsoft Entra ID and Postman.

Step 2: Configure Postman to support provisioning with Microsoft Entra ID

Before you begin to configure Postman to support provisioning with Microsoft Entra ID, you’ll need to generate a SCIM API token within the Postman Admin Console.

Note

You can visit the page Postman SCIM provisioning overview, to refer Enable SCIM provisioning in Postman steps.

  1. Navigate to Postman Admin Console by logging in to your Postman account.

  2. Once you’ve logged in, click Team on the right side and click Team Settings.

  3. Select Authentication in the sidebar and then turn on the SCIM provisioning toggle.

    Screenshot of Postman authentication settings page.

  4. You will receive a pop up message asking whether you want to Turn on SCIM Provisioning, click Turn On to enable SCIM provisioning.

    Screenshot of modal to enable SCIM provisioning.

  5. To Generate SCIM API Key, perform the following steps:

    1. Select Generate SCIM API Key in the SCIM provisioning section.

      Screenshot to generate SCIM API key in Postman.

    2. Enter name of the key and click Generate.

    3. Copy your new API key for later use and click Done.

    Note

    You can revisit this page to manage your SCIM API keys. If you regenerate an existing API key, you will have the option to keep the first key active while you switch over.

    Note

    To continue enabling SCIM provisioning, see Configuring SCIM with Microsoft Entra ID. For further information or help configuring SCIM, contact Postman support.

Add Postman from the Microsoft Entra application gallery to start managing provisioning to Postman. If you have previously set up Postman for SSO you can use the same application. However, it's recommended that you create a separate app when testing out the integration initially. Learn more about adding an application from the gallery here.

Step 4: Define who will be in scope for provisioning

The Microsoft Entra provisioning service allows you to scope who will be provisioned based on assignment to the application and or based on attributes of the user / group. If you choose to scope who will be provisioned to your app based on assignment, you can use the following steps to assign users and groups to the application. If you choose to scope who will be provisioned based solely on attributes of the user or group, you can use a scoping filter as described here.

  • Start small. Test with a small set of users and groups before rolling out to everyone. When the scope for provisioning is set to assigned users and groups, you can control this by assigning one or two users or groups to the app. When the scope is set to all users and groups, you can specify an attribute based scoping filter.

  • If you need more roles, you can update the application manifest to add new roles.

Step 5: Configure automatic user provisioning to Postman

This section guides you through the steps to configure the Microsoft Entra provisioning service to create, update, and disable users and/or groups in TestApp based on user and/or group assignments in Microsoft Entra ID.

To configure automatic user provisioning for Postman in Microsoft Entra ID:

  1. Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.

  2. Browse to Identity > Applications > Enterprise applications

    Screenshot of Enterprise applications blade.

  3. In the applications list, select Postman.

    Screenshot of the Postman link in the Applications list.

  4. Select the Provisioning tab.

    Screenshot of Provisioning tab.

  5. Set the Provisioning Mode to Automatic.

    Screenshot of Provisioning tab automatic.

  6. Under the Admin Credentials section, input https://api.getpostman.com/scim/v2/ as your Postman Tenant URL and your SCIM API key as the Secret Token. Click Test Connection to ensure Microsoft Entra ID can connect to Postman. If the connection fails, ensure your Postman account has Admin permissions and try again.

    Screenshot of Token.

  7. In the Notification Email field, enter the email address of a person or group who should receive the provisioning error notifications and select the Send an email notification when a failure occurs check box.

    Screenshot of Notification Email.

  8. Select Save.

  9. Under the Mappings section, select Synchronize Microsoft Entra users to Postman.

  10. Review the user attributes that are synchronized from Microsoft Entra ID to Postman in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the user accounts in Postman for update operations. If you choose to change the matching target attribute, you'll need to ensure that the Postman API supports filtering users based on that attribute. Select the Save button to commit any changes.

    Attribute Type Supported for filtering Required by Postman
    userName String
    active Boolean
    name.givenName String
    name.familyName String
  11. Under the Mappings section, select Synchronize Microsoft Entra groups to Postman.

  12. Review the group attributes that are synchronized from Microsoft Entra ID to Postman in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the groups in Postman for update operations. Select the Save button to commit any changes.

    Attribute Type Supported for filtering Required by Postman
    displayName String
    members Reference
  13. To configure scoping filters, refer to the following instructions provided in the Scoping filter tutorial.

  14. To enable the Microsoft Entra provisioning service for Postman, change the Provisioning Status to On in the Settings section.

    Screenshot of Provisioning Status Toggled On.

  15. Define the users and/or groups that you would like to provision to Postman by choosing the desired values in Scope in the Settings section.

    Screenshot of Provisioning Scope.

  16. When you're ready to provision, click Save.

    Screenshot of Saving Provisioning Configuration.

This operation starts the initial synchronization cycle of all users and groups defined in Scope in the Settings section. The initial cycle takes longer to perform than subsequent cycles, which occur approximately every 40 minutes as long as the Microsoft Entra provisioning service is running.

Step 6: Monitor your deployment

Once you've configured provisioning, use the following resources to monitor your deployment:

  • Use the provisioning logs to determine which users have been provisioned successfully or unsuccessfully.
  • Check the progress bar to see the status of the provisioning cycle and how close it's to completion.
  • If the provisioning configuration seems to be in an unhealthy state, the application goes into quarantine. Learn more about quarantine states here.

More resources

Next steps