UpdateTeam

PATCH/api/v1/teams/{team}

Update metadata about a team such as a team’s description.

Example request

US
Europe

curl -X PATCH \
  -H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{ "displayName": "string" }' \
  "https://us.oblique.security/api/v1/teams/{team}?updateMask=displayName"

Set OBLIQUE_API_KEY to your API key.

curl -X PATCH \
  -H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{ "displayName": "string" }' \
  "https://eu.oblique.security/api/v1/teams/{team}?updateMask=displayName"

Set OBLIQUE_API_KEY to your API key.

Path parameters

team.namestringrequired
Assigned by Oblique. Name of the team of the format teams/{team}.

Query parameters

updateMaskstring (field-mask)
The list of fields to update.
allowMissingboolean
If set to true, and the team is not found, a new team will be created with the given name. If created in this way, update_mask is ignored.

Request body

displayNamestringrequired
Displayed name of the team.
descriptionstring
Longer description.
managementManagement
How this team is managed. Set automatically by the server based on the calling client. Omitted from responses when the team is manually managed (the default).
- managerstring
  Allowed values: TERRAFORM
  How the API object is managed. Set automatically by the server based on the caller: Terraform clients produce TERRAFORM; for all other clients the management field is left unset on the response.
- repoUristring
  URI of the VCS repository that holds the Terraform configuration for this API object. Populated by the Oblique Terraform provider.
- repoDirstring
  Optionally, the subdirectory within repo_uri that holds the Terraform configuration for this API object. Populated by the Oblique Terraform provider.
createTimestring (date-time)read-only
Create and update timestamps.
updateTimestring (date-time)read-only
deleteTimestring (date-time)read-only
Teams can only be soft-deleted to preserve logs and history.
memberCountinteger (int32)read-only
The number of members in the team.

Response

200Team

A team represents a group of users. Teams can be hierarchical by specifying a single parent, but can’t be arbitrarily nested.

namestring
Assigned by Oblique. Name of the team of the format teams/{team}.
displayNamestringrequired
Displayed name of the team.
descriptionstring
Longer description.
managementManagement
How this team is managed. Set automatically by the server based on the calling client. Omitted from responses when the team is manually managed (the default).
- managerstring
  Allowed values: TERRAFORM
  How the API object is managed. Set automatically by the server based on the caller: Terraform clients produce TERRAFORM; for all other clients the management field is left unset on the response.
- repoUristring
  URI of the VCS repository that holds the Terraform configuration for this API object. Populated by the Oblique Terraform provider.
- repoDirstring
  Optionally, the subdirectory within repo_uri that holds the Terraform configuration for this API object. Populated by the Oblique Terraform provider.
createTimestring (date-time)read-only
Create and update timestamps.
updateTimestring (date-time)read-only
deleteTimestring (date-time)read-only
Teams can only be soft-deleted to preserve logs and history.
memberCountinteger (int32)read-only
The number of members in the team.

Errors

Status	Meaning
`400`	Malformed request
`401`	Missing or invalid API key
`403`	Not allowed for this API key
`404`	Not found
`429`	Too many requests
`500`	Internal server error