GIgitguardian
Teams

Update a team

Changed on

Update a team's name and/or its description.

If you are using a personal access token, you must have "can manage" permission on the team or be a workspace manager.

The "All-incidents" team (is_global=true) cannot be updated.

patch/v1/teams/{team_id}

Request

  • Base URL
    https://api.gitguardian.com
  • URL
    https://api.gitguardian.com/v1/teams/{team_id}
  • Auth
    HTTP bearer

Path parameters

team_idinteger required

The id of the team

Request body

idinteger
namestring
descriptionstring nullable

team description.

is_globalboolean
gitguardian_urlstring
external_provider_idstring nullable

ID of the external provider associated to the team.

external_provider_typestring nullable

Type of the external provider associated to the team.

Example request

{
  "id": 3252,
  "name": "feature team A",
  "description": "Description of my team",
  "gitguardian_url": "https://dashboard.gitguardian.com/workspace/1/settings/user/teams/1",
  "external_provider_id": "123-456-7890",
  "external_provider_type": "okta"
}

Response

The team was updated successfully.

idinteger
namestring
descriptionstring nullable

team description.

is_globalboolean
gitguardian_urlstring
external_provider_idstring nullable

ID of the external provider associated to the team.

external_provider_typestring nullable

Type of the external provider associated to the team.

Example response

{
  "id": 3252,
  "name": "feature team A",
  "description": "Description of my team",
  "gitguardian_url": "https://dashboard.gitguardian.com/workspace/1/settings/user/teams/1",
  "external_provider_id": "123-456-7890",
  "external_provider_type": "okta"
}

Changes

  • 9ae1cffd3970Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status