Skip to content

Commit c6d9f7d

Browse files
authored
API docs update for CCE425 Silent PAT rotation (#909)
This PR updates the API documentation for OAuth clients to include information about silent PAT (Personal Access Token) rotation (CCE 425) Adds documentation for the oauth-token-string parameter in the PATCH endpoint
2 parents 4ea1cad + c943613 commit c6d9f7d

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

content/terraform-docs-common/docs/cloud-docs/api-docs/oauth-clients.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -376,6 +376,7 @@ This PATCH endpoint requires a JSON object with the following properties as a re
376376
| `data.attributes.secret` | string | (previous value) | The OAuth client secret. For Bitbucket Data Center, this secret is the text of the SSH private key associated with your Bitbucket Data Center application link. |
377377
| `data.attributes.rsa-public-key` | string | (previous value) | **Required for Bitbucket Data Center in conjunction with the `secret`. Not used for any other providers.** The text of the SSH public key associated with your Bitbucket Data Center application link. |
378378
| `data.attributes.organization-scoped` | boolean | (previous value) | Whether or not the OAuth client is available to all projects and workspaces in the organization. |
379+
| `data.attributes.oauth-token-string` | string | (previous value) | The personal access token string. Set this field to update the token when rotating credentials. Updating this value does not trigger new runs, and HCP Terraform uses the new token for all subsequent runs. |
379380
| `data.relationships.projects` | array\[object] | (previous value) | A list of resource identifier objects that defines which projects are associated with the OAuth client. If `data.attributes.organization-scoped` is set to `false`, the OAuth client is only available to this list of projects. Each object in this list must contain a project `id` and use the `"projects"` type. For example, `{ "id": "prj-AwfuCJTkdai4xj9w", "type": "projects" }`. Sending an empty array clears all project assignments. |
380381
| `data.relationships.agent-pool.data` | object | `{}` | The Agent Pool associated to the VCS connection. This pool will be responsible for forwarding VCS Provider API calls and cloning VCS repositories. |
381382

@@ -389,7 +390,8 @@ This PATCH endpoint requires a JSON object with the following properties as a re
389390
"attributes": {
390391
"key": "key",
391392
"secret": "secret",
392-
"organization-scoped": false
393+
"organization-scoped": false,
394+
"oauth-token-string": "74653028376f0009d0ed81f1b654ac17a"
393395
},
394396
"relationships": {
395397
"projects": {

0 commit comments

Comments
 (0)