Skip to main content

​
After this article

You will be able to connect Postman to Lumos to sync and manage users, groups, workspace roles, and workspaces, including last-login activity data for license management.

​
Capabilities

Note: activity tracking covers login events only, API collection usage and request activity are not tracked.

​
Required plan and roles

  • Postman plan: full functionality requires a Postman Enterprise plan. SCIM endpoints (used for users and groups) are available on Postman Team, Business, and Enterprise plans.
  • Postman role: the API key should be created by a Team Admin or Super Admin, and must be a team-level key (not a personal key).
  • Credentials: the integration takes two credentials, and both are required:
    • API key: reads workspaces, workspace roles, and the audit log that last-login activity is built from. Can be regenerated or revoked anytime from Postman settings.
    • SCIM API key: used for the SCIM endpoints that list and manage users and groups. This is where user and group sync comes from, as well as provisioning.
  • Permission scoping: there is no sync-only setup that skips the SCIM API key. User and group sync runs through the SCIM endpoints, and the connection is not validated unless both keys work.

​
Read-only access vs provisioning

Is read-only possible? No. The connection takes two credentials and neither is optional. The SCIM API key cannot be left blank, the connection is not validated unless that key works, and user and group sync itself runs through the SCIM endpoints rather than the plain API key. Because the SCIM key is also the credential Lumos writes with, there is no way to connect for sync alone. What full provisioning requires. A team-level API key generated by a Team Admin or Super Admin in Postman settings, not a personal key, plus a SCIM API key generated by following Postman’s SCIM provisioning guidelines. SCIM must be enabled for your team, which requires a Postman Team, Business, or Enterprise plan, and full functionality requires Enterprise. Follow the steps below. Watch out for. Leaving the SCIM API key out is not a way to get a safer, read-only connection. The connection fails to validate. The two keys cover different halves of the sync, workspaces and last-login activity come from the plain API key while users and groups come from SCIM, so if one key is wrong you lose part of the data rather than all of it. Workspaces are always sync-only, Lumos never provisions or removes workspaces even with both keys connected.

​
Instructions

Phase 1: Generate keys in Postman
  1. As a Team Admin or Super Admin, generate a team-level API key in your Postman settings.
  2. Generate a SCIM API key following Postman’s SCIM provisioning guidelines (SCIM must be enabled for your team. Available on Team, Business, and Enterprise plans).
Phase 2: Connect in Lumos
  1. Find the Postman card in your Lumos integrations (reconnect an existing card or add a new one).
  2. Follow the instructions in the pop-up, providing the API key and SCIM API key.
  3. Click Connect.

​
API Endpoints Used

​
Troubleshooting

Users not syncing. Verify the API key was created by a Team Admin or Super Admin and hasn’t been revoked. Ensure users have accepted their team invitations and have email addresses in their Postman profiles. Confirm you are on a plan that includes API access for user management, then review the integration logs in Lumos. API key authentication failures. Confirm the complete key was copied without extra spaces, it hasn’t been revoked, and it belongs to an active admin account on an active (not suspended) team. Make sure you are using a team-level API key, not a personal key. Generate a new key if needed. Workspaces not appearing. Verify the key’s user has admin access to team workspaces, the workspaces are team workspaces (not personal), and check workspace visibility settings. Incomplete team data. Verify the key was created by a user with full team admin access, members have completed their profiles and accepted invitations, and review the team settings and member list in Postman. Plan limitations. Verify you are on a Postman Team, Business, or Enterprise plan and that it includes API access for user management. Full functionality requires Enterprise. Contact Postman support for plan-specific API limitations.