Skip to content

Commit 92d9152

Browse files
authored
Remove user from team API update documentation (#1066)
The current documentation says to delete a user based on the user id however the API expects the username. Usernames for teams are unique. This PR updates [doc](https://developer.hashicorp.com/terraform/enterprise/api-docs/team-members#delete-a-user-from-team-with-user-id ) to say username instead of user id Jira ticket: https://hashicorp.atlassian.net/browse/IPL-7085
2 parents 9133cd2 + 5a2c31a commit 92d9152

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

content/terraform-docs-common/docs/cloud-docs/api-docs/team-members.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -160,9 +160,9 @@ curl \
160160
https://app.terraform.io/api/v2/teams/257525/relationships/organization-memberships
161161
```
162162

163-
## Delete a User from Team (With user ID)
163+
## Delete a User from Team (With username)
164164

165-
This method removes multiple users from a team using the user ID. Both users and teams must already exist. This method only removes a user from this team. It does not delete that user overall.
165+
This method removes multiple users from a team using the username. Both users and teams must already exist. This method only removes a user from this team. It does not delete that user overall.
166166

167167
`DELETE /teams/:team_id/relationships/users`
168168

@@ -179,7 +179,7 @@ Properties without a default value are required.
179179
| Key path | Type | Default | Description |
180180
| ------------- | ------ | ------- | ----------------------------------- |
181181
| `data[].type` | string | | Must be `"users"`. |
182-
| `data[].id` | string | | The ID of the user to remove from this team. |
182+
| `data[].id` | string | | The username of the user to remove from this team. |
183183

184184
### Sample Payload
185185

0 commit comments

Comments
 (0)