Reauthorizing VCS connections

Introduction

In some scenarios, a Version Control System (VCS) connection in HCP Terraform or Terraform Enterprise may disconnect unexpectedly. This can disrupt workflows that rely on webhooks for runs, policy sets, or the private module registry.

The Reauthorize feature allows you to repair a broken VCS connection without disconnecting it from your workspaces. This guide explains how to use this feature.

Use Case

You may need to reauthorize a VCS connection due to:

• Token refresh failures.
• Incorrect or revoked tokens on the VCS provider.

Prerequisites

This feature is available in the following Terraform editions:

• HCP Terraform
• Terraform Enterprise version v202211-1 and newer

Procedure

Follow these steps to reauthorize a VCS connection.

1. Navigate to your organization's settings page.
2. Select Providers from the Version Control section in the sidebar.
3. Locate the VCS connection you need to fix and select the Reauthorize button next to its OAuth Token ID.

Important Considerations

The reauthorization process is similar to revoking and re-establishing a connection. However, unlike the Revoke Connection option, reauthorizing preserves the link between the VCS client and your existing workspaces.

• Use for broken connections: We recommend using this feature primarily to repair connections that are already broken.
• Avoid changing authorized users: Do not use this feature to change the authorized user for a healthy connection, as this could alter repository permissions and impact your workspaces.