CI Auth Token

Exchange CI token

Exchanges a CI token for a short-lived Zephyr access token using actor identity inferred by the plugin. This route does not call CI provider APIs.

post/v2/ci-token/exchange

Request

  • Base URL: https://api.zephyr-cloud.io
  • URL: https://api.zephyr-cloud.io/v2/ci-token/exchange
  • Auth: HTTP bearer

Request body

OR
OR

Example request

{
  "email": "builder@example.com",
  "emails": [
    "builder@example.com",
    "12345+builder@users.noreply.github.com"
  ],
  "provider": "github",
  "issuer": "https://github.com",
  "providerSubject": "1234567",
  "username": "octocat",
  "providerActorType": "user",
  "source": "oidc"
}

Response

Exchange result

access_tokenstring required

Short-lived Zephyr access token minted for the CI-inferred actor.

Changes

No recorded changes to this operation across all 1 revision of this API.