Skip to navigation

Manage service account identities for automation and integrations

View as Markdown

This feature is available on Postman Enterprise plans. For more information, see the pricing page.

System service accounts give your team a dedicated, non-human identity for automation, integrations, and system-to-system interactions. Instead of tying CI/CD pipelines or backend services to a person’s credentials, you can create a service account that represents the system itself with its own access controls, credentials, and audit trail.

A service account is a non-human identity you create, for example, admin@company.com. A system service account is an internal automation identity Postman provides, for example, postman-ci-service-account. To learn more about user-created service accounts, see Assign the Admin user.

You must be an Admin or Super Admin to create and manage service accounts.

Create a system service account

To create a system service account, do the following:

  1. Click your profile and select your team or organization.

  2. Click Service accounts in the left sidebar.

  3. Click Create Service Account.

    Create Service Account form
  4. Fill in the fields below, then click Create Service Account.

    Create service account form fields

    You can update the account’s name, description, and access assignments at any time after creation.

    Name
    Required

    A descriptive name for the system or integration this account represents.

    Description

    Additional context about the account’s purpose.

    Organization role
    Defaults to DeveloperRequired

    The role or roles this service account will have in the organization. If your team isn’t part of an organization, this field is named Team role.

Assign teams and workspaces

After creating the system service account, assign it to the teams and workspaces it needs to access, and then set up and generate API keys for authentication.

Service Account team and workspace assignment

To assign the service account to teams and workspaces, do the following:

  1. Select the service account from the Service accounts list.
  2. Under Assigned teams, select the teams you want the account to belong to.
  3. Under Assigned workspaces, select each workspace you want the account to access and assign the appropriate workspace role.

Next, you can learn more about workspace roles and what each one allows.

Manage access and permissions

System service accounts use the same role-based access control (RBAC) as team members. The role you assign determines what the account can see and do across your organization, teams, and workspaces.

The following table summarizes the available roles and capabilities for system service accounts at each scope. For detailed information on what each role can do, see Roles and permissions.

ScopeRoleCapabilities
OrganizationOrganization Manager (Super Admin)Full access to everything.
TeamTeam Manager (Admin)Manages the team.
Team Member-DeveloperHas access to team workspaces. Can be granted elevated workspace access.
Collaborator-DeveloperHas view and edit access to explicitly assigned workspaces only.
Collaborator-ViewerHas view-only access to explicitly assigned workspaces only.
WorkspaceAdminManages workspace resources.
EditorModifies collections and APIs.
ViewerHas read-only access.

Manage API key settings

Each system service account uses a two-step credential model:

  1. A long-lived API key is used to obtain a short-lived access token.
  2. The short-lived token provides access to Postman APIs and is the credential you use in your systems.

Token expiration isn’t configurable. You can configure API key expiration and regenerate API keys.

To configure API key expiration for a system service account, do the following:

  1. Select the service account from the Service accounts list.
  2. Under API key settings, select one of the following:
    • Never expire API keys - API keys stay active until you turn them off or delete them.
    • API keys expire after - Select 30, 60, or 180 days of inactivity. The default is 60 days.
  3. Click Save API Key Settings.

If an Admin has set API key expiration for the whole team, you can’t change these settings for a service account.

The short-lived token is similar to a token generated when a user authenticates and enables the integration to perform Postman actions on their behalf.

Generate an API key

To generate an API key for a system service account, do the following:

  1. Select the service account from the Service accounts list.
  2. Click Generate API Key.
  3. Give the key a descriptive name, for example “ci-key”.
  4. Click Generate.
  5. Copy the API key and store it in a secure location.

The API key is only displayed once. You won’t be able to view it again after dismissing the dialog.

Retrieve a short-lived token

Use the API key to obtain a short-lived session token for your automation scripts and integrations.

To obtain a short-lived session token, do the following:

  1. Copy the API key generated in the previous step.
  2. Make an API call with the key passed as the x-api-key HTTP header.
  3. Use the session token returned in the response for subsequent API calls.

Manage credentials

Admins and Super Admins can view all system service accounts across the team, including their roles, assigned teams and workspaces, and API keys.

As an Admin, for each service account, you can do the following:

  • Generate an API key.
  • Regenerate an API key.
  • Rename an API key.
  • Turn an API key on or off with its Status control.
  • Delete an API key.
  • View the creation date, creator, expiration date, and status for each key.

To regenerate an API key, click the Options icon options icon next to the key, and then select Regenerate. Copy the new key and update your systems to use it. Postman deletes the existing key automatically after 6 hours, which gives you time to switch over. To delete the existing key right away instead, select Delete the existing key now before you click Regenerate API Key.

You can also rotate a service account’s credentials manually:

  1. Generate a new API key on the service account.
  2. Update your downstream systems to use the new key.
  3. Delete the previous API key once the new one is in place.

SCIM API keys

If your team uses SCIM provisioning, you can create a SCIM API key that’s owned by a system service account instead of an individual user. Because the key belongs to the service account rather than a person, your SCIM integration keeps working even if the Admin who set it up leaves the team.

SCIM API keys are separate from the service account API keys. Use a SCIM API key only to authenticate SCIM requests from your identity provider (IdP).

Before you create a SCIM API key, make sure of the following:

Create a SCIM API key

To create a SCIM API key for a system service account, do the following:

  1. Select the service account from the Service accounts list.
  2. In the SCIM API keys section, click Create SCIM API key.
  3. Enter a Key name so you can identify the key later, for example, “example-scim-key”.
  4. Click Create.
  5. Copy the SCIM API key and store it in a secure location.

The SCIM API key is only displayed once. You won’t be able to view it again after dismissing the dialog.

To authenticate SCIM requests, enter the key as the bearer token in your IdP. For provider-specific steps, see Configure SCIM with Okta, Configure SCIM with Microsoft Entra ID, or Configure SCIM with OneLogin.

Manage SCIM API keys

Each SCIM API key appears in the SCIM API keys section, attributed to the service account that owns it, along with its expiration date and status. For each key, you can do the following:

  • Rename the key.
  • Turn on or turn off the key.
  • Regenerate the key to replace it with a new one. The new key is displayed only once.
  • Delete the key.

Analyze audit logs

The audit log captures the following events about your service account API keys:

  • API key created
  • API key deleted
  • API key regenerated
  • API key activated
  • API key deactivated
  • API key renamed

To view audit logs, see Audit logs.

About security

System service accounts are designed to limit exposure at every stage of the credential lifecycle. Tokens are short-lived by default, so a compromised token has a narrow window of usefulness. When you need to rotate credentials, you can hold multiple API keys simultaneously, update your systems with the new key, and only then revoke the previous one. There’s no forced downtime.