HashiCorp Developer AI Private beta now available Sign up today
Terraform
Terraform Home

You are viewing documentation for version v202301-1. View latest version.

Organization Token API

Generate a new organization token

POST /organizations/:organization_name/authentication-token

ParameterDescription
:organization_nameThe name of the organization to generate a token for.

Generates a new organization API token, replacing any existing token.

Only members of the owners team, the owners team API token, and the organization API token can access this endpoint.

StatusResponseReason
201JSON API document (type: "authentication-tokens")Success
404JSON API error objectUser not authorized

Sample Request

curl \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/vnd.api+json" \
  --request POST \
  https://app.terraform.io/api/v2/organizations/my-organization/authentication-token

Sample 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"
    },
    "relationships": {
      "created-by": {
        "data": {
          "id": "user-62goNpx1ThQf689e",
          "type": "users"
        }
      }
    }
  }
}

Delete the organization token

DELETE /organizations/:organization/authentication-token

ParameterDescription
:organization_nameWhich organization's token should be deleted.

Only members of the owners team, the owners team API token, and the organization API token can access this endpoint.

StatusResponseReason
204NothingSuccess
404JSON API error objectUser 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