> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect Postman with API Key – StackOne Hub

> Link a Postman account in the StackOne Hub using API Key. End-user guide to authorize the integration and start using Postman actions.

> [!WARNING]
>
> Create the key while signed in as a team Admin, the smallest team role that manages members and groups. A Super Admin key also works, but Super Admin adds access to every workspace, which this connection does not read. Postman API keys have no scopes and carry the permissions of the person who creates them. Postman does not document which role lists every member, so a key from a user with fewer rights may return fewer members or be refused. Groups exist only on Postman Enterprise plans.

## Create a Postman API key

A Postman API key lets StackOne read your team's users and groups. One connection reads the team the key was created in, so connect once per team. Use a personal key from your account settings; keys from **Service Accounts** are exchanged for a short-lived token, which this connection does not do.

**1. Sign in to Postman**

Sign in to your [Postman account](https://go.postman.co/home) as a team Admin.

<ul>
  <li>Click **Sign in with SSO** if your team uses single sign-on.</li>
  <li>If your team uses Postman EU Data Residency, sign in to your EU account in the Postman desktop app. To add it, select **Help** > **Region Preference for New Accounts** > **Use EU Region by Default**, then sign in. Create the key there so it belongs to the EU region.</li>
  <li>If you belong to more than one team, select your avatar in the Postman header, then **Switch to** and choose the team you want to connect.</li>
  <li>Click **Settings** in the top right of the Postman header, then **Account settings**.</li>
</ul>

**2. Open API keys**

In your account settings, click **API keys**.

<ul>
  <li>Shortcut: [API keys](https://go.postman.co/settings/me/api-keys)</li>
</ul>

**3. Generate the key**

Click **Generate API Key**.

<ul>
  <li>Name: `StackOne Integration`</li>
  <li>Click **Generate API Key** again to confirm the name.</li>
</ul>

**4. Copy the key**

Copy your key and store it securely for use later.

<ul>
  <li>Paste it into the **API Key** field in StackOne Hub.</li>
  <li>To limit how long your keys last, use **API key settings** on the API keys page to set an expiration period. Your team's admin may have turned this off, and on Enterprise the organization's **Set expiry for API keys** setting overrides it. When the key expires, the connection stops working until you paste a new key into StackOne Hub.</li>
</ul>

## Find your region

The **Region** is the Postman data center that hosts your team. Leave it empty or select **US** for the standard US region.

<ul>
  <li>Select **EU** only if your team uses Postman EU Data Residency, an Enterprise feature hosted in Frankfurt.</li>
  <li>Your Postman Enterprise admin knows whether the team is on EU Data Residency.</li>
  <li>If the connection is refused, check that **Region** matches the region your team is hosted in.</li>
  <li>Select the option in the **Region** field in StackOne Hub.</li>
</ul>

## Know what a smaller role breaks

The connection test reads your team's member list, and your own profile only when that list is empty. Reading members' roles or groups also reads the team's groups.

<ul>
  <li>A key from a user who is not a team Admin may pass the connection test and then be refused when StackOne reads roles or groups.</li>
  <li>With an Admin key on a plan without groups, members show no groups and only the roles given to them directly.</li>
</ul>

## Revoke the key

To stop StackOne from reading your team, revoke the key.

<ul>
  <li>Return to **Settings** > **Account settings** > **API keys**.</li>
  <li>Click the more actions icon next to the key and delete it. To rotate it instead, click regenerate there and paste the new value into the **API Key** field in StackOne Hub.</li>
  <li>On Enterprise, an Admin or Super Admin can revoke any key in the dashboard at **Organization** > **Postman Keys** by hovering over the key and clicking **Revoke**.</li>
</ul>

## Linking the Account from the Hub

**1. Navigate to the Hub**

Use one of the three [Linking Account Methods](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md) to access the Hub.

**2. Fill out the fields**

Fill out the following fields using details from your provider:

<ul>
  <li>**API Key**</li>
  <li>**Region** (Optional)</li>
</ul>

**3. Connect**

<ul>
  <li>Click **Connect**</li>
  <li>If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider's authorization flow.</li>
  <li>Once authorization is successful, you will see a confirmation popup</li>
</ul>

If the account linking is successful, you will see the newly linked account on your [Accounts](https://app.stackone.com/accounts) page.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.