Team Token API

Generate a new team token

Generates a new team token and overrides existing token if one exists.

Method	Path
POST	/teams/:team_id/authentication-token

This endpoint returns the secret text of the new authentication token. You can only access this token when you create it and can not recover it later.

Parameters

:team_id (string: <required>) - specifies the team ID for generating the team token

Request Body

This POST endpoint requires a JSON object with the following properties as a request payload.

Key path	Type	Default	Description
`data.type`	string		Must be `"authentication-token"`.
`data.attributes.expired-at`	string	`null`	The UTC date and time that the Team Token will expire, in ISO 8601 format. If omitted or set to `null` the token will never expire.

Sample Payload

{
  "data": {
    "type": "authentication-token",
    "attributes": {
      "expired-at": "2023-04-06T12:00:00.000Z"
    }
  }
}

Sample Request

curl \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/vnd.api+json" \
  --request POST \
  --data @payload.json \
  https://app.terraform.io/api/v2/teams/team-BUHBEM97xboT8TVz/authentication-token

Sample Response

{
  "data": {
    "id": "4111797",
    "type": "authentication-tokens",
    "attributes": {
      "created-at": "2017-11-29T19:18:09.976Z",
      "last-used-at": null,
      "description": null,
      "token": "QnbSxjjhVMHJgw.atlasv1.gxZnWIjI5j752DGqdwEUVLOFf0mtyaQ00H9bA1j90qWb254lEkQyOdfqqcq9zZL7Sm0",
      "expired-at": "2023-04-06T12:00:00.000Z"
    },
    "relationships": {
      "created-by": {
        "data": {
          "id": "user-62goNpx1ThQf689e",
          "type": "users"
        }
      }
    }
  }
}

Delete the team token

Method	Path
DELETE	/teams/:team_id/authentication-token

Parameters

:team_id (string: <required>) - specifies the team_id from which to delete the token

Sample Request

curl \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/vnd.api+json" \
  --request DELETE \
  https://app.terraform.io/api/v2/teams/team-BUHBEM97xboT8TVz/authentication-token