ClientService

Update Team

Updates an existing Team. Only the fields named in the update mask are changed; when no mask is given, every field set on the team is updated.

patch/v1/organizations/{organization}/teams/{team}

Request

  • Base URL: https://api.thirdfort.dev/client/api
  • URL: https://api.thirdfort.dev/client/api/v1/organizations/{organization}/teams/{team}
  • Auth: HTTP bearer

Path parameters

organizationstring required

The organization identifier of the resource path.

teamstring required

The team identifier of the resource path.

Request body

displayNamestring

Required. The human readable name of the team.

brandstring

Required. The resource name of the Brand this team uses. The brand must belong to the same organization as the team. Format: organizations/{organization}/brands/{brand}.

descriptionstring

Optional. A human readable description of the team.

deleteTimestring date-time

The time at which the team was deleted. Unset for a live team. A deleted team is still returned by GetTeam and BatchGetTeams, but is excluded from ListTeams. A deleted team cannot be restored.

Response

A successful response.

namestring

The unique resource name of the team. Format: organizations/{organization}/teams/{team}. This field is system-generated and immutable.

displayNamestring required

Required. The human readable name of the team.

brandstring required

Required. The resource name of the Brand this team uses. The brand must belong to the same organization as the team. Format: organizations/{organization}/brands/{brand}.

descriptionstring

Optional. A human readable description of the team.

deleteTimestring date-time

The time at which the team was deleted. Unset for a live team. A deleted team is still returned by GetTeam and BatchGetTeams, but is excluded from ListTeams. A deleted team cannot be restored.

Changes

No recorded changes to this operation across all 1 revision of this API.