postman-cs/Postman Onboarding: Service Token
Recommended credential producer for Postman API Onboarding. Mints a service-account access token and team ID in CI.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| postman-api-key | Recommended credential source. Service-account Postman API key (PMAK) used to mint a fresh access token. Required when postman-access-token is not provided. | no | "" |
| postman-access-token | Compatibility input for externally rotated Postman access tokens. When provided, minting is skipped, this value is returned via outputs.token, and the action warns because fresh service-account minting is preferred. | no | "" |
| postman-team-id | Optional pre-known Postman team ID. When provided, the team ID lookup is skipped and this value is returned via outputs.team-id. Recommended with postman-access-token pass-through. | no | "" |
| postman-region | Postman data residency region for public API calls. One of: us or eu. Use the same region as the target Postman team. | no | us |
| postman-stack | Postman stack profile. Defaults to the public production stack. Marketplace workflows should leave this as prod. | no | prod |
| write-github-secret | When 'true', writes the resolved token and team ID to repo secrets named by access-token-secret-name and team-id-secret-name. Requires github-token to be a PAT (or GitHub App installation token) with secrets write permission on the target repo. The default GITHUB_TOKEN cannot write repo secrets. | no | false |
| access-token-secret-name | Repo secret name to receive the resolved access token. Used only when write-github-secret is 'true'. | no | POSTMAN_ACCESS_TOKEN |
| team-id-secret-name | Repo secret name to receive the resolved team ID. Used only when write-github-secret is 'true'. | no | POSTMAN_TEAM_ID |
| github-token | GitHub PAT or App installation token with secrets write permission on the target repo. Required when write-github-secret is 'true'. | no | "" |
Outputs
| name | description |
|---|---|
| token | Resolved Postman access token. Either minted or passed through from the postman-access-token input. |
| team-id | Resolved Postman team ID. Either looked up via /me or passed through from the postman-team-id input. |
| skipped | 'true' when minting was skipped because postman-access-token was provided as input. |