HashiCorp Developer AI Private beta now available Sign up today
Terraform
Terraform Home

You are viewing documentation for version v202210-1. View latest version.

Team Membership API

Note: Team management is a paid feature, available as part of the Team upgrade package. Free organizations can also use this API, but can only manage membership of their owners team. Learn more about Terraform Cloud pricing here.

The Team Membership API is used to add or remove users from teams. The Team API is used to create or destroy teams.

Organization Membership

Note: To add users to a team, they must first be invited to join the organization by email, and accept the invitation. This ensures that you don't accidentally add the wrong person by mistyping a username. See the Organization Memberships API documentation for more information.

Add a User to Team

This method adds multiple users to a team. Both users and teams must already exist.

POST /teams/:team_id/relationships/users

ParameterDescription
:team_idThe ID of the team.

Request Body

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

Properties without a default value are required.

Key pathTypeDefaultDescription
data[].typestringMust be "users".
data[].idstringThe username of the user to add.

Sample Payload

{
  "data": [
    {
      "type": "users",
      "id": "myuser1"
    },
    {
      "type": "users",
      "id": "myuser2"
    }
  ]
}

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/teams/257525/relationships/users

Delete a User from Team

This method removes multiple users from a team. Both users and teams must already exist. This DOES NOT delete the user; it only removes them from this team.

DELETE /teams/:team_id/relationships/users

ParameterDescription
:team_idThe ID of the team.

Request Body

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

Properties without a default value are required.

Key pathTypeDefaultDescription
data[].typestringMust be "users".
data[].idstringThe username of the user to remove.

Sample Payload

{
  "data": [
    {
      "type": "users",
      "id": "myuser1"
    },
    {
      "type": "users",
      "id": "myuser2"
    }
  ]
}

Sample Request

$ curl \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/vnd.api+json" \
  --request DELETE \
  --data @payload.json \
  https://app.terraform.io/api/v2/teams/257525/relationships/users