post/auth/cli/tokenWrite operation

Exchange a TeamGrid CLI authorization code

Exchanges a short-lived, single-use authorization code for a cell-local TeamGrid CLI personal credential. This is a fixed first-party public-client protocol operation: it requires PKCE S256, the exact IPv4 loopback redirect used during browser approval, and no bearer credential. Send the request only to the regional API host returned by the browser callback. The response is reveal-once and must never be logged or cached.

Request example

curl --request POST \
  --url 'https://api.de.teamgrid.app/v1/auth/cli/token' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "authorizationCode": "example",
    "clientId": "string",
    "codeVerifier": "example",
    "grantType": "string",
    "redirectUri": "example"
  }'

const response = await fetch('https://api.de.teamgrid.app/v1/auth/cli/token', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "authorizationCode": "example",
  "clientId": "string",
  "codeVerifier": "example",
  "grantType": "string",
  "redirectUri": "example"
}),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/auth/cli/token', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "authorizationCode": "example",
  "clientId": "string",
  "codeVerifier": "example",
  "grantType": "string",
  "redirectUri": "example"
}),
})

const result: ApiResponse = await response.json()

teamgrid auth token \
  --data @payload.json

Example response 2xx

{
  "data": {
    "attributes": {
      "accessToken": "string",
      "cellId": "string",
      "expiresAt": "2026-07-29T09:00:00.000Z",
      "grantId": "string",
      "region": "string",
      "replayed": false,
      "scopes": [
        "string"
      ],
      "tokenType": "string"
    },
    "id": "example",
    "type": "string"
  },
  "meta": {
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

JSON request bodyValid JSON

Generated cURL

The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.

Request body

application/json

authorizationCoderequired

string

clientIdrequired

string

codeVerifierrequired

string

grantTyperequired

string

redirectUrirequired

string

Responses

200The code was consumed and the reveal-once CLI credential was issued.application/json

Response schemaapplication/json

required

object

required

ResponseMeta

Public API representation of meta.

400The request is invalid.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

429The credential or source exceeded its rate limit.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

502The cell-local application returned an invalid response.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

503A required cell-local dependency is unavailable.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

Operation IDexchangeCliAuthorizationCodeOpenAPI JSON ↗

Documentation feedbackWas this page useful?