Audit trail tokens API reference

Audit trail tokens are used to authenticate integrations pulling audit trail data, for example, using the HCP Terraform for Splunk app.

Generate a new token

POST /organizations/:organization_name/authentication-token?token=audit-trails

Generates a new audit trails 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.

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.

Request Body

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

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-token?token=audit-trails

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",
      "expired-at": "2023-04-06T12:00:00.000Z"
    },
    "relationships": {
      "created-by": {
        "data": {
          "id": "user-62goNpx1ThQf689e",
          "type": "users"
        }
      }
    }
  }
}

Delete a token

DELETE /organizations/:organization/authentication-token?token=audit-trails

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

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?token=audit-trails