GIgitguardian
Public Secret Incidents

Update the collaborators of a public secret incident

Changed on

Add and remove workspace members in the collaborators of a public secret incident, in one request.

The request changes only what differs from the current collaborators:

  • A member who is already a collaborator is not added again.
  • A member who is not a collaborator is not removed.
  • An id that is not a member of the workspace is ignored.
  • A member who is not active, who is a bot, or who cannot view the incident is not added.
  • A resolved or ignored incident does not change.

The response gives the collaborators after the change. Compare it with the request to find the members that were not added.

The same member cannot be in member_ids_to_add and in member_ids_to_remove.

If incident collaborators are not enabled for the workspace, a 404 is returned.

Prerequisites:

  • A valid API key with the incidents:write scope.
  • Edit access on the incident.
patch/v1/public-incidents/secrets/{incident_id}/collaborators

Request

Path parameters

incident_idinteger required

The id of the incident to retrieve

Request body

member_ids_to_addinteger[]

Ids of the workspace members to add to the collaborators. The incident does not get a member who is not active, who is a bot, or who cannot view the incident.

member_ids_to_removeinteger[]

Ids of the workspace members to remove from the collaborators.

Example request

{
  "member_ids_to_add": [
    42
  ],
  "member_ids_to_remove": [
    38
  ]
}

Response

Collaborators of the public secret incident after the change.

member_idsinteger[] required

Ids of the workspace members who collaborate on the incident, sorted in ascending order.

Example response

{
  "member_ids": [
    38,
    42
  ]
}

Changes