Sign in
latestOpenAPI 3.0.3GitGuardian2026-08-201871515.0 MB

511b067cdcb1

Public Secret Incidents

Assign a public secret incident

Assign a public secret incident to a workspace member by email or member ID.

post/v1/public-incidents/secrets/{incident_id}/assign

Path parameters

incident_idinteger required

The id of the incident to retrieve

Query parameters

send_emailboolean

Whether to notify the assignee.

Request body

emailstring

email of the member to assign. This parameter is mutually exclusive with member_id.

member_idnumber

id of the member to assign. This parameter is mutually exclusive with email.

Example request

{
  "email": "eric@gitguardian.com",
  "member_id": 4295
}

Response

Public Secret Incident Details

idinteger
datestring date-time
secret_idinteger
secret_hashstring
hmsl_hashstring
occurrences_countinteger
status'IGNORED' | 'TRIGGERED' | 'ASSIGNED' | 'RESOLVED'
triggered_atstring date-time
ignored_atstring date-time nullable
ignore_reason'test_credential' | 'false_positive' | 'low_risk' | 'invalid' | 'ignore_actor' | 'ignore_secret' nullable

Comma-separated list of the reasons why the incident was ignored.

ignorer_idinteger nullable
ignorer_api_token_idstring uuid nullable
resolved_atstring date-time nullable
resolver_idinteger nullable
resolver_api_token_idstring uuid nullable
secret_revokedboolean
validity'valid' | 'invalid' | 'failed_to_check' | 'no_checker' | 'unknown'
severity'critical' | 'high' | 'medium' | 'low' | 'info' | 'unknown'
assignee_idinteger nullable
assignee_emailstring nullable
share_urlstring nullable
declarative_secret_status'revoked' | 'active' | 'test_credential' | 'false_positive' | 'low_risk'
resolve_reason'revoked' | 'dmca_request' | 'source_deleted' nullable

Comma-separated list of the reasons why the incident was resolved.

gitguardian_urlstring
tagsstring[]
risk_scoreinteger

Risk score of the incident, from 0 (low) to 100 (critical).

severity_rule_idinteger nullable

ID of the severity rule that set this incident's severity. Null if severity was not set by a rule or was manually overridden.

incident_namestring

Human-readable name combining detector information

is_vaultedboolean nullable

Indicates whether this secret is stored in a vault (NHI observability feature)

Example response

{
  "id": 3759,
  "detector": {
    "name": "slack_bot_token",
    "display_name": "Slack Bot Token",
    "nature": "specific",
    "family": "token",
    "category": "messaging_system",
    "detector_group_name": "slackbot_token",
    "detector_group_display_name": "Slack Bot Token"
  },
  "date": "2019-08-22T14:15:22Z",
  "secret_id": 1,
  "secret_hash": "Ri9FjVgdOlPnBmujoxP4XPJcbe82BhJXB/SAngijw/juCISuOMgPzYhV28m6OG24",
  "hmsl_hash": "05975add34ddc9a38a0fb57c7d3e676ffed57080516fc16bf8d8f14308fedb86",
  "occurrences_count": 4,
  "triggered_at": "2019-05-12T09:37:49Z",
  "ignored_at": "2019-08-24T14:15:22Z",
  "ignore_reason": "test_credential,ignore_actor",
  "ignorer_id": 309,
  "ignorer_api_token_id": "fdf075f9-1662-4cf1-9171-af50568158a8",
  "resolver_id": 395,
  "resolver_api_token_id": "fdf075f9-1662-4cf1-9171-af50568158a8",
  "validity": "valid",
  "severity": "high",
  "assignee_id": 309,
  "assignee_email": "eric@gitguardian.com",
  "share_url": "https://dashboard.gitguardian.com/share/public-incidents/11111111-1111-1111-1111-111111111111",
  "feedback_list": [
    {
      "created_at": "2021-05-20T12:40:55.662949Z",
      "updated_at": "2021-05-20T12:40:55.662949Z",
      "member_id": 42,
      "email": "eric@gitguardian.com",
      "answers": [
        {
          "field_ref": "actual_secret_yes_no",
          "field_label": "Is it an actual secret?",
          "boolean": true
        }
      ]
    }
  ],
  "resolve_reason": "revoked",
  "gitguardian_url": "https://dashboard.gitguardian.com/workspace/1/public-incidents/3899",
  "tags": [
    "FROM_HISTORICAL_SCAN",
    "INTERNALLY_LEAKED"
  ],
  "custom_tags": [
    {
      "id": "d45a123f-b15d-4fea-abf6-ff2a8479de5b",
      "key": "env",
      "value": "prod"
    }
  ],
  "risk_score": 80,
  "severity_rule_id": 42,
  "incident_name": "Stripe Token"
}