Skip to content

Commit 602dca3

Browse files
emlanctothelenjw
authored andcommitted
docs: cloud docs for user token disablement
1 parent 4f66230 commit 602dca3

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

content/terraform-docs-common/docs/cloud-docs/users-teams-organizations/api-tokens.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,21 @@ Refer to [Team Token API](/terraform/cloud-docs/api-docs/team-tokens) and [Organ
1616

1717
API tokens may belong directly to a user. User tokens are the most flexible token type because they inherit permissions from the user they are associated with. For more information on user tokens and how to generate them, see the [Users](/terraform/cloud-docs/users-teams-organizations/users#tokens) documentation.
1818

19+
### Disabling user tokens for organizations
20+
21+
When user tokens are disabled for an organization, all user tokens will be blocked from accessing organization resources. By default, user tokens are enabled for organizations.
22+
23+
1. Sign in to [HCP Terraform](https://app.terraform.io/) or Terraform Enterprise, then navigate to the organization where you want to disable user tokens.
24+
1. Choose **Settings** from the sidebar, then **API tokens**.
25+
1. From the **User Tokens** tab, uncheck the **Allow members to access organization resources with their user tokens** setting.
26+
1. Click **Update settings**.
27+
1. In the confirmation modal, select **Disable**.
28+
1. User tokens are now disabled for this organization.
29+
30+
!> **Warning:** Use caution disabling user tokens for an organization. This could cause automation to fail if the automation is using user tokens to authenticate.
31+
32+
-> **Note:** When user tokens are disabled for an organization, that organization should use `oauth-token-id` to configure their VCS connections rather than `github-app-installation-id`, as the latter relies on user tokens to authenticate to Github.
33+
1934
## Team API Tokens
2035

2136
API tokens may belong to a specific team. Team API tokens allow access to the workspaces that the team has access to, without being tied to any specific user.

content/terraform-docs-common/docs/cloud-docs/users-teams-organizations/users.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,10 @@ To revoke a token, click the **trash can** next to it. That token will no longer
191191

192192
~> **Note**: HCP Terraform does not revoke a user API token's access to an organization when you remove the user from an SSO Identity Provider as the user may still be a member of the organization. To remove access to a user's API token, remove the user from the organization in the UI or with the [Terraform Enterprise provider](https://registry.terraform.io/providers/hashicorp/tfe/latest).
193193

194+
#### Tokens disabled
195+
196+
User tokens can be disabled at the organization level, for more information see the [API token](/terraform/cloud-docs/users-teams-organizations/api-tokens#user-api-tokens) documentation.
197+
194198
### GitHub app OAuth token
195199

196200
Click **Tokens** in the sidebar to manage your GitHub App token. This token lets you connect a workspaces to an available GitHub App installation.

0 commit comments

Comments
 (0)