Organization Token API
Generate a new organization token
POST /organizations/:organization_name/authentication-token
| Parameter | Description |
|---|---|
:organization_name | The name of the organization to generate a token for. |
Generates a neworganization API token, replacing any existing token.
Only members of the owners team, the ownersteam API token, and theorganization API token can access this endpoint.
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.
| Status | Response | Reason |
|---|---|---|
| 201 | JSON API document (type: "authentication-tokens") | Success |
| 404 | JSON API error object | User not authorized |
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 Organization Token will expire, in ISO 8601 format. If omitted or set tonull 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/organizations/my-organization/authentication-tokenSample Response
{ "data": { "id": "4111756", "type": "authentication-tokens", "attributes": { "created-at": "2017-11-29T19:11:28.075Z", "last-used-at": null, "description": null, "token": "ZgqYdzuvlv8Iyg.atlasv1.6nV7t1OyFls341jo1xdZTP72fN0uu9VL55ozqzekfmToGFbhoFvvygIRy2mwVAXomOE", "expired-at": "2023-04-06T12:00:00.000Z" }, "relationships": { "created-by": { "data": { "id": "user-62goNpx1ThQf689e", "type": "users" } } } }}Delete the organization token
DELETE /organizations/:organization/authentication-token
| Parameter | Description |
|---|---|
:organization_name | Which organization's token should be deleted. |
Only members of the owners team, the ownersteam API token, and theorganization API token can access this endpoint.
| Status | Response | Reason |
|---|---|---|
| 204 | No Content | Success |
| 404 | JSON API error object | User not authorized |
Sample Request
curl \ --header "Authorization: Bearer $TOKEN" \ --header "Content-Type: application/vnd.api+json" \ --request DELETE \ https://app.terraform.io/api/v2/organizations/my-organization/authentication-token