Can I use GitGuardian as a CLI?

Yes. KosmoKrator exposes a GitGuardian CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose GitGuardian through MCP?

Yes. The KosmoKrator MCP gateway can expose selected GitGuardian tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are GitGuardian credentials stored?

GitGuardian credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for GitGuardian MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

data

GitGuardian Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the GitGuardian KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.gitguardian.*. Use lua_read_doc("integrations.gitguardian") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic GitGuardian workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.gitguardian.self_retrieve_api_token({}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("gitguardian"))' --json
kosmo integrations:lua --eval 'print(docs.read("gitguardian.self_retrieve_api_token"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local gitguardian = app.integrations.gitguardian
local result = gitguardian.self_retrieve_api_token({})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.gitguardian, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.gitguardian.default.* or app.integrations.gitguardian.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need GitGuardian, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

GitGuardian Integration

Use the gitguardian integration to scan content for secrets and manage GitGuardian workspace resources such as incidents, sources, teams, members, SCIM users and groups, honeytokens, audit logs, custom tags, IP allowlists, invitations, and quotas.

All tools are generated from the official GitGuardian OpenAPI document at https://api.gitguardian.com/v1/openapi.json. Configure a GitGuardian API key; runtime calls send Authorization: Token <api_key>.

Common Tools

gitguardian_content_scan, gitguardian_multiple_scan, and gitguardian_scan_create_incidents scan content and optionally create incidents.
gitguardian_list_incidents, gitguardian_retrieve_incidents, gitguardian_update_secret_incident, and action tools manage internal secret incidents.
Public incident, note, member, team, invitation, source, honeytoken, custom tag, IP allowlist, audit log, and SCIM tools map directly to the official v1 endpoints.
SCIM tools use application/scim+json request bodies where the upstream spec requires it.

Return Shape

JSON responses are returned as decoded arrays/objects from GitGuardian. Empty successful responses return { success = true, status = <http_status> }.

Examples

local scan = app.integrations.gitguardian.content_scan({
  body = {
    document = "token = 'dummy-example-token'",
    filename = "example.txt"
  }
})

local incidents = app.integrations.gitguardian.list_incidents({
  per_page = 20,
  status = "TRIGGERED"
})

local token = app.integrations.gitguardian.self_retrieve_api_token({})

Never place real secrets, repository names, customer emails, or production source identifiers in tests, fixtures, prompts, or Lua examples.

Raw agent markdown

# GitGuardian Integration

Use the `gitguardian` integration to scan content for secrets and manage GitGuardian workspace resources such as incidents, sources, teams, members, SCIM users and groups, honeytokens, audit logs, custom tags, IP allowlists, invitations, and quotas.

All tools are generated from the official GitGuardian OpenAPI document at `https://api.gitguardian.com/v1/openapi.json`. Configure a GitGuardian API key; runtime calls send `Authorization: Token <api_key>`.

## Common Tools

- `gitguardian_content_scan`, `gitguardian_multiple_scan`, and `gitguardian_scan_create_incidents` scan content and optionally create incidents.
- `gitguardian_list_incidents`, `gitguardian_retrieve_incidents`, `gitguardian_update_secret_incident`, and action tools manage internal secret incidents.
- Public incident, note, member, team, invitation, source, honeytoken, custom tag, IP allowlist, audit log, and SCIM tools map directly to the official v1 endpoints.
- SCIM tools use `application/scim+json` request bodies where the upstream spec requires it.

## Return Shape

JSON responses are returned as decoded arrays/objects from GitGuardian. Empty successful responses return `{ success = true, status = <http_status> }`.

## Examples

```lua
local scan = app.integrations.gitguardian.content_scan({
  body = {
    document = "token = 'dummy-example-token'",
    filename = "example.txt"
  }
})

local incidents = app.integrations.gitguardian.list_incidents({
  per_page = 20,
  status = "TRIGGERED"
})

local token = app.integrations.gitguardian.self_retrieve_api_token({})
```

Never place real secrets, repository names, customer emails, or production source identifiers in tests, fixtures, prompts, or Lua examples.

Metadata-derived Lua example

local result = app.integrations.gitguardian.self_retrieve_api_token({})
print(result)

Functions

self_retrieve_api_token Read

Retrieve details of the current API token. Official GitGuardian endpoint: GET /v1/api_tokens/self.

Lua path: app.integrations.gitguardian.self_retrieve_api_token
Full name: gitguardian.gitguardian_self_retrieve_api_token

Parameter	Type	Required	Description
No parameters.

self_delete_api_token Write

Revoke the current API token. Official GitGuardian endpoint: DELETE /v1/api_tokens/self.

Lua path: app.integrations.gitguardian.self_delete_api_token
Full name: gitguardian.gitguardian_self_delete_api_token

Parameter	Type	Required	Description
No parameters.

list_api_tokens Read

List all the tokens in the workspace, some filters are available and described below. Official GitGuardian endpoint: GET /v1/api_tokens.

Lua path: app.integrations.gitguardian.list_api_tokens
Full name: gitguardian.gitguardian_list_api_tokens

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`status`	string	no	status
`member_id`	number	no	Filter by member id.
`creator_id`	number	no	Filter by creator id.
`scopes`	string	no	scopes
`search`	string	no	search
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.

retrieve_api_token Read

Retrieve details of an API token. Official GitGuardian endpoint: GET /v1/api_tokens/{token_id}.

Lua path: app.integrations.gitguardian.retrieve_api_token
Full name: gitguardian.gitguardian_retrieve_api_token

Parameter	Type	Required	Description
`token_id`	string	yes	Id of the token.

delete_api_token Write

Revoke an API token. Official GitGuardian endpoint: DELETE /v1/api_tokens/{token_id}.

Lua path: app.integrations.gitguardian.delete_api_token
Full name: gitguardian.gitguardian_delete_api_token

Parameter	Type	Required	Description
`token_id`	string	yes	Id of the token.

public_jwt_create Read

Create a short lived JWT for authentication to specific GitGuardian services, including HasMySecretLeaked. Official GitGuardian endpoint: POST /v1/auth/jwt.

Lua path: app.integrations.gitguardian.public_jwt_create
Full name: gitguardian.gitguardian_public_jwt_create

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

list_incidents Read

List secret incidents detected by the GitGuardian dashboard. Occurrences are not returned in this route. Official GitGuardian endpoint: GET /v1/incidents/secrets.

Lua path: app.integrations.gitguardian.list_incidents
Full name: gitguardian.gitguardian_list_incidents

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`page`	number	no	Page number.
`per_page`	number	no	Number of items to list per page.
`date_before`	string	no	date_before
`date_after`	string	no	date_after
`triggered_at_before`	string	no	triggered_at_before
`triggered_at_after`	string	no	triggered_at_after
`assignee_email`	string	no	assignee_email
`assignee_id`	number	no	assignee_id
`status`	string	no	status
`severity`	string	no	severity
`validity`	string	no	validity
`tags`	string	no	tags
`exclude_tags`	string	no	exclude_tags
`custom_tags`	string	no	custom_tags
`custom_tag_key`	string	no	custom_tag_key
`custom_tag_value`	string	no	custom_tag_value
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.
`detector_group_name`	string	no	detector_group_name
`ignorer_id`	number	no	ignorer_id
`ignorer_api_token_id`	string	no	ignorer_api_token_id
`resolver_id`	number	no	resolver_id
`resolver_api_token_id`	string	no	resolver_api_token_id
`feedback`	boolean	no	feedback
`only_on_provider_archived_sources`	boolean	no	only_on_provider_archived_sources
`risk_score_min`	number	no	risk_score_min
`risk_score_max`	number	no	risk_score_max

retrieve_incidents Read

Retrieve secret incident detected by the GitGuardian dashboard with its occurrences. Official GitGuardian endpoint: GET /v1/incidents/secrets/{incident_id}.

Lua path: app.integrations.gitguardian.retrieve_incidents
Full name: gitguardian.gitguardian_retrieve_incidents

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`with_occurrences`	number	no	Retrieve a number of occurrences of this incident.

update_secret_incident Write

Update a secret incident. Official GitGuardian endpoint: PATCH /v1/incidents/secrets/{incident_id}.

Lua path: app.integrations.gitguardian.update_secret_incident
Full name: gitguardian.gitguardian_update_secret_incident

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

retrieve_incidents_leaks Read

Retrieve where a secret has been publicly leaked. **Limitations:** - Does not work for multimatch secrets. - Does not return publicly visible internal sources. Official GitGuardian endpoint: GET /v1/incidents/secrets/{incident_id}/leaks.

Lua path: app.integrations.gitguardian.retrieve_incidents_leaks
Full name: gitguardian.gitguardian_retrieve_incidents_leaks

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve

assign_incident Write

Assign secret incident detected by the GitGuardian dashboard to a workspace member by email. Official GitGuardian endpoint: POST /v1/incidents/secrets/{incident_id}/assign.

Lua path: app.integrations.gitguardian.assign_incident
Full name: gitguardian.gitguardian_assign_incident

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`send_email`	boolean	no	Whether to notify the assignee.
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

unassign_incident Read

Unassign secret incident from a workspace member by email. Official GitGuardian endpoint: POST /v1/incidents/secrets/{incident_id}/unassign.

Lua path: app.integrations.gitguardian.unassign_incident
Full name: gitguardian.gitguardian_unassign_incident

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

resolve_incident Read

Resolve a secret incident detected by the GitGuardian dashboard. Official GitGuardian endpoint: POST /v1/incidents/secrets/{incident_id}/resolve.

Lua path: app.integrations.gitguardian.resolve_incident
Full name: gitguardian.gitguardian_resolve_incident

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

ignore_incident Read

Ignore a secret incident detected by the GitGuardian dashboard. Official GitGuardian endpoint: POST /v1/incidents/secrets/{incident_id}/ignore.

Lua path: app.integrations.gitguardian.ignore_incident
Full name: gitguardian.gitguardian_ignore_incident

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

reopen_incident Read

Unresolve or unignore a secret incident detected by the GitGuardian dashboard. Official GitGuardian endpoint: POST /v1/incidents/secrets/{incident_id}/reopen.

Lua path: app.integrations.gitguardian.reopen_incident
Full name: gitguardian.gitguardian_reopen_incident

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

share_incident Read

Share a secret incident by creating a public link. Official GitGuardian endpoint: POST /v1/incidents/secrets/{incident_id}/share.

Lua path: app.integrations.gitguardian.share_incident
Full name: gitguardian.gitguardian_share_incident

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

unshare_incident Read

Unshare a secret incident by revoking its public link. Official GitGuardian endpoint: POST /v1/incidents/secrets/{incident_id}/unshare.

Lua path: app.integrations.gitguardian.unshare_incident
Full name: gitguardian.gitguardian_unshare_incident

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

grant_access_incident Read

Grant a user, an existing invitee or a team access to a secret incident. DEPRECATED: This endpoint has been replaced by [this one](#tag/Members/operation/set-member-resource-access) for members, [this one](#tag/Teams/operation/set-team-resource-access) for teams, and [this one](#tag/Invitations/operation/set-invitation-resource-access) for invitations. Official GitGuardian endpoint: POST /v1/incidents/secrets/{incident_id}/grant_access.

Lua path: app.integrations.gitguardian.grant_access_incident
Full name: gitguardian.gitguardian_grant_access_incident

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

revoke_access_incident Read

Revoke access to a secret incident Official GitGuardian endpoint: POST /v1/incidents/secrets/{incident_id}/revoke_access.

Lua path: app.integrations.gitguardian.revoke_access_incident
Full name: gitguardian.gitguardian_revoke_access_incident

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

list_incident_notes Read

List notes left on a secret incident in chronological order. Official GitGuardian endpoint: GET /v1/incidents/secrets/{incident_id}/notes.

Lua path: app.integrations.gitguardian.list_incident_notes
Full name: gitguardian.gitguardian_list_incident_notes

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`cursor`	string	no	Pagination cursor.
`page`	number	no	Page number.
`per_page`	number	no	Number of items to list per page.
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.
`member_id`	number	no	Filter by member id.
`search`	string	no	search

create_incident_note Write

Add a note on a secret incident. Official GitGuardian endpoint: POST /v1/incidents/secrets/{incident_id}/notes.

Lua path: app.integrations.gitguardian.create_incident_note
Full name: gitguardian.gitguardian_create_incident_note

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

update_incident_note Write

Update an existing comment on a secret incident. Only incident notes created by the current API key can be updated. Official GitGuardian endpoint: PATCH /v1/incidents/secrets/{incident_id}/notes/{note_id}.

Lua path: app.integrations.gitguardian.update_incident_note
Full name: gitguardian.gitguardian_update_incident_note

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`note_id`	number	yes	The id of the incident note to update
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

delete_incident_note Write

Delete an existing comment on a secret incident. Only incident notes created by the current API key can be deleted. Official GitGuardian endpoint: DELETE /v1/incidents/secrets/{incident_id}/notes/{note_id}.

Lua path: app.integrations.gitguardian.delete_incident_note
Full name: gitguardian.gitguardian_delete_incident_note

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`note_id`	number	yes	The id of the incident note to delete

list_incident_members Read

List all the members having access to a secret incident. DEPRECATED: This endpoint has been replaced by [/v1/secret-incidents/{incident_id}/members](#tag/Secret-Incidents/operation/list-secret-incident-member-access) Official GitGuardian endpoint: GET /v1/incidents/secrets/{incident_id}/members.

Lua path: app.integrations.gitguardian.list_incident_members
Full name: gitguardian.gitguardian_list_incident_members

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`cursor`	string	no	Pagination cursor.
`page`	number	no	Page number.
`per_page`	number	no	Number of items to list per page.
`member_id`	number	no	member_id
`incident_permission`	string	no	incident_permission
`role`	string	no	role
`search`	string	no	search

list_incident_teams Read

List all the teams having access to a secret incident. DEPRECATED: This endpoint has been replaced by [/v1/secret-incidents/{incident_id}/teams](#tag/Secret-Incidents/operation/list-secret-incident-team-access) Official GitGuardian endpoint: GET /v1/incidents/secrets/{incident_id}/teams.

Lua path: app.integrations.gitguardian.list_incident_teams
Full name: gitguardian.gitguardian_list_incident_teams

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`cursor`	string	no	Pagination cursor.
`team_id`	number	no	team_id
`incident_permission`	string	no	incident_permission

list_incident_invitations Read

List all the invitations having access to a Secret Incident. DEPRECATED: This endpoint has been replaced by [/v1/secret-incidents/{incident_id}/invitations](#tag/Secret-Incidents/operation/list-secret-incident-invitation-access) Official GitGuardian endpoint: GET /v1/incidents/secrets/{incident_id}/invitations.

Lua path: app.integrations.gitguardian.list_incident_invitations
Full name: gitguardian.gitguardian_list_incident_invitations

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`cursor`	string	no	Pagination cursor.
`invitation_id`	number	no	invitation_id
`incident_permission`	string	no	filter accesses with a specific permission.

retrieve_incident_impacted_perimeter Read

Retrieve metrics about the impacted perimeter of a secret incident detected by the GitGuardian dashboard. Official GitGuardian endpoint: GET /v1/incidents/secrets/{incident_id}/impacted_perimeter.

Lua path: app.integrations.gitguardian.retrieve_incident_impacted_perimeter
Full name: gitguardian.gitguardian_retrieve_incident_impacted_perimeter

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve

get_secret_incident_vaults Read

Returns detailed vault path information if the secret is stored in a vault. This endpoint requires the NHI (Non-Human Identity) feature to be enabled and the `show_vault_path_in_public_api` setting to be active. If either condition is not met, an empty array is returned. Official GitGuardian endpoint: GET /v1/incidents/secrets/{incident_id}/vaults.

Lua path: app.integrations.gitguardian.get_secret_incident_vaults
Full name: gitguardian.gitguardian_get_secret_incident_vaults

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve

list_secret_incident_member_access Read

List members that have access to a secret incident. Official GitGuardian endpoint: GET /v1/secret-incidents/{incident_id}/members.

Lua path: app.integrations.gitguardian.list_secret_incident_member_access
Full name: gitguardian.gitguardian_list_secret_incident_member_access

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`role`	string	no	role
`access_level`	string	no	access_level
`search`	string	no	search
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.
`direct_access`	boolean	no	Filter on direct or indirect accesses.

list_secret_incident_team_access Read

List teams that have access to a secret incident. Official GitGuardian endpoint: GET /v1/secret-incidents/{incident_id}/teams.

Lua path: app.integrations.gitguardian.list_secret_incident_team_access
Full name: gitguardian.gitguardian_list_secret_incident_team_access

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`search`	string	no	search
`direct_access`	boolean	no	Filter on direct or indirect accesses.

list_secret_incident_invitation_access Read

List invitations that have access to a secret incident. Official GitGuardian endpoint: GET /v1/secret-incidents/{incident_id}/invitations.

Lua path: app.integrations.gitguardian.list_secret_incident_invitation_access
Full name: gitguardian.gitguardian_list_secret_incident_invitation_access

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`search`	string	no	search
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.
`direct_access`	boolean	no	Filter on direct or indirect accesses.

list_occs Read

List occurrences of secrets in the monitored perimeter. Official GitGuardian endpoint: GET /v1/occurrences/secrets.

Lua path: app.integrations.gitguardian.list_occs
Full name: gitguardian.gitguardian_list_occs

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`page`	number	no	Page number.
`per_page`	number	no	Number of items to list per page.
`date_before`	string	no	date_before
`date_after`	string	no	date_after
`source_id`	number	no	Filter on the source ID.
`source_name`	string	no	source_name
`source_type`	string	no	source_type
`incident_id`	number	no	Filter by incident ID.
`incident_assignee_id`	number	no	Filter by incident assignee member ID.
`presence`	string	no	presence
`author_name`	string	no	author_name
`author_info`	string	no	author_info
`sha`	string	no	sha
`filepath`	string	no	filepath
`severity`	string	no	severity
`status`	string	no	status
`validity`	string	no	validity
`tags`	string	no	tags
`exclude_tags`	string	no	exclude_tags
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.

list_severity_rules Read

List the severity rules currently active for the workspace. These rules determine how incident severity is automatically assigned. Use the rule `id` to correlate with the `severity_rule_id` field on incidents. Official GitGuardian endpoint: GET /v1/severity-rules.

Lua path: app.integrations.gitguardian.list_severity_rules
Full name: gitguardian.gitguardian_list_severity_rules

Parameter	Type	Required	Description
No parameters.

create_code_fix_request Write

Create code fix requests for multiple secret incidents with their locations. This will generate pull requests to automatically remediate the detected secrets. Each request must include: - One or more issues (by issue_id) - One or more location IDs for each issue The system will group locations by source repository and create one pull request per source. Official GitGuardian endpoint: POST /v1/code-fix-requests.

Lua path: app.integrations.gitguardian.create_code_fix_request
Full name: gitguardian.gitguardian_create_code_fix_request

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official GitGuardian OpenAPI schema.

list_public_incidents Read

List public secret incidents detected by the GitGuardian dashboard. Official GitGuardian endpoint: GET /v1/public-incidents/secrets.

Lua path: app.integrations.gitguardian.list_public_incidents
Full name: gitguardian.gitguardian_list_public_incidents

Parameter	Type	Required	Description
`x_privacy_mode`	string	no	When set to `true`, sensitive values in the response are obfuscated (replaced with `<GG>OBFUSCATED</GG>`). Useful for sharing API responses without exposing sensitive data.
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`date_before`	string	no	date_before
`date_after`	string	no	date_after
`triggered_at_before`	string	no	triggered_at_before
`triggered_at_after`	string	no	triggered_at_after
`assignee_email`	string	no	assignee_email
`assignee_id`	number	no	assignee_id
`status`	string	no	status
`severity`	string	no	severity
`validity`	string	no	validity
`tags`	string	no	tags
`custom_tags`	string	no	custom_tags
`custom_tag_key`	string	no	custom_tag_key
`custom_tag_value`	string	no	custom_tag_value
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.
`detector_group_name`	string	no	detector_group_name
`ignorer_id`	number	no	ignorer_id
`ignorer_api_token_id`	string	no	ignorer_api_token_id
`resolver_id`	number	no	resolver_id
`resolver_api_token_id`	string	no	resolver_api_token_id
`feedback`	boolean	no	feedback
`declarative_secret_status`	string	no	declarative_secret_status
`risk_score_min`	number	no	risk_score_min
`risk_score_max`	number	no	risk_score_max

retrieve_public_incidents Read

Retrieve public secret incident detected by the GitGuardian dashboard Official GitGuardian endpoint: GET /v1/public-incidents/secrets/{incident_id}.

Lua path: app.integrations.gitguardian.retrieve_public_incidents
Full name: gitguardian.gitguardian_retrieve_public_incidents

Parameter	Type	Required	Description
`x_privacy_mode`	string	no	When set to `true`, sensitive values in the response are obfuscated (replaced with `<GG>OBFUSCATED</GG>`). Useful for sharing API responses without exposing sensitive data.
`incident_id`	number	yes	The id of the incident to retrieve

list_public_secret_occurrences Read

List occurrences of a public secret incident detected by the GitGuardian dashboard Official GitGuardian endpoint: GET /v1/public-incidents/secrets/{incident_id}/occurrences.

Lua path: app.integrations.gitguardian.list_public_secret_occurrences
Full name: gitguardian.gitguardian_list_public_secret_occurrences

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`date_before`	string	no	date_before
`date_after`	string	no	date_after
`source_id`	number	no	Filter on the source ID.
`presence`	string	no	presence
`sha`	string	no	sha
`filepath`	string	no	filepath
`attachment_reason`	string	no	attachment_reason
`severity`	string	no	severity
`status`	string	no	status
`validity`	string	no	validity
`tags`	string	no	tags
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.

retrieve_public_secret_occurrence Read

Retrieve a specific occurrence of a public secret incident detected by the GitGuardian dashboard Official GitGuardian endpoint: GET /v1/public-incidents/secrets/{incident_id}/occurrences/{occurrence_id}.

Lua path: app.integrations.gitguardian.retrieve_public_secret_occurrence
Full name: gitguardian.gitguardian_retrieve_public_secret_occurrence

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`occurrence_id`	number	yes	The ID of the occurrence to retrieve

resolve_public_incidents Read

Resolve a public secret incident detected by the GitGuardian dashboard. Official GitGuardian endpoint: POST /v1/public-incidents/secrets/{incident_id}/resolve.

Lua path: app.integrations.gitguardian.resolve_public_incidents
Full name: gitguardian.gitguardian_resolve_public_incidents

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

ignore_public_incidents Read

Ignore a public secret incident detected by the GitGuardian dashboard. Official GitGuardian endpoint: POST /v1/public-incidents/secrets/{incident_id}/ignore.

Lua path: app.integrations.gitguardian.ignore_public_incidents
Full name: gitguardian.gitguardian_ignore_public_incidents

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

reopen_public_incidents Read

Reopen a public secret incident that was previously resolved or ignored. Official GitGuardian endpoint: POST /v1/public-incidents/secrets/{incident_id}/reopen.

Lua path: app.integrations.gitguardian.reopen_public_incidents
Full name: gitguardian.gitguardian_reopen_public_incidents

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

assign_public_incidents Write

Assign a public secret incident to a workspace member by email or member ID. Official GitGuardian endpoint: POST /v1/public-incidents/secrets/{incident_id}/assign.

Lua path: app.integrations.gitguardian.assign_public_incidents
Full name: gitguardian.gitguardian_assign_public_incidents

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`send_email`	boolean	no	Whether to notify the assignee.
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

unassign_public_incidents Read

Unassign a public secret incident from its current assignee. Official GitGuardian endpoint: POST /v1/public-incidents/secrets/{incident_id}/unassign.

Lua path: app.integrations.gitguardian.unassign_public_incidents
Full name: gitguardian.gitguardian_unassign_public_incidents

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

share_public_incidents Read

Create a public link to share a public secret incident with an external developer. Official GitGuardian endpoint: POST /v1/public-incidents/secrets/{incident_id}/share.

Lua path: app.integrations.gitguardian.share_public_incidents
Full name: gitguardian.gitguardian_share_public_incidents

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

unshare_public_incidents Read

Delete a public secret incident's share link. Official GitGuardian endpoint: POST /v1/public-incidents/secrets/{incident_id}/unshare.

Lua path: app.integrations.gitguardian.unshare_public_incidents
Full name: gitguardian.gitguardian_unshare_public_incidents

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

set_severity_public_incidents Read

Set the severity of a public secret incident. Official GitGuardian endpoint: POST /v1/public-incidents/secrets/{incident_id}/set_severity.

Lua path: app.integrations.gitguardian.set_severity_public_incidents
Full name: gitguardian.gitguardian_set_severity_public_incidents

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

set_custom_tags_public_incidents Read

Set the custom tags of a public secret incident. Official GitGuardian endpoint: POST /v1/public-incidents/secrets/{incident_id}/set_custom_tags.

Lua path: app.integrations.gitguardian.set_custom_tags_public_incidents
Full name: gitguardian.gitguardian_set_custom_tags_public_incidents

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

list_public_incident_notes Read

List notes left on a public secret incident in chronological order. Official GitGuardian endpoint: GET /v1/public-incidents/secrets/{incident_id}/notes.

Lua path: app.integrations.gitguardian.list_public_incident_notes
Full name: gitguardian.gitguardian_list_public_incident_notes

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.
`member_id`	number	no	Filter by member id.
`search`	string	no	search

create_public_incident_note Write

Add a note on a public secret incident. Official GitGuardian endpoint: POST /v1/public-incidents/secrets/{incident_id}/notes.

Lua path: app.integrations.gitguardian.create_public_incident_note
Full name: gitguardian.gitguardian_create_public_incident_note

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

update_public_incident_note Write

Update an existing comment on a public secret incident. Only incident notes created by the current API key can be updated. Official GitGuardian endpoint: PATCH /v1/public-incidents/secrets/{incident_id}/notes/{note_id}.

Lua path: app.integrations.gitguardian.update_public_incident_note
Full name: gitguardian.gitguardian_update_public_incident_note

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`note_id`	number	yes	The id of the incident note to update
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

delete_public_incident_note Write

Delete an existing comment on a public secret incident. Only incident notes created by the current API key can be deleted. Official GitGuardian endpoint: DELETE /v1/public-incidents/secrets/{incident_id}/notes/{note_id}.

Lua path: app.integrations.gitguardian.delete_public_incident_note
Full name: gitguardian.gitguardian_delete_public_incident_note

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve
`note_id`	number	yes	The id of the incident note to delete

get_public_secret_incident_vaults Read

Lua path: app.integrations.gitguardian.get_public_secret_incident_vaults
Full name: gitguardian.gitguardian_get_public_secret_incident_vaults

Parameter	Type	Required	Description
`incident_id`	number	yes	The id of the incident to retrieve

list_invitations Read

This endpoint allows you to list all pending invitations. The response contains the list of invitations and a pagination cursor to retrieve the next page. The invitations are sorted by id. If you are using a personal access token, you need to have an access level superior or equal to `member`. Official GitGuardian endpoint: GET /v1/invitations.

Lua path: app.integrations.gitguardian.list_invitations
Full name: gitguardian.gitguardian_list_invitations

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`search`	string	no	search
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.

create_invitations Write

This endpoint allows you to send an invitation to a user. If you are using a personal access token, you need to have an access level superior or equal to `member`. Official GitGuardian endpoint: POST /v1/invitations.

Lua path: app.integrations.gitguardian.create_invitations
Full name: gitguardian.gitguardian_create_invitations

Parameter	Type	Required	Description
`send_email`	boolean	no	Whether to send an email to the invitee with a link to accept the invitation.
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

retrieve_invitation Read

Retrieve an existing invitation. If you are using a personal access token, you need to have an access level superior or equal to `member`. Official GitGuardian endpoint: GET /v1/invitations/{invitation_id}.

Lua path: app.integrations.gitguardian.retrieve_invitation
Full name: gitguardian.gitguardian_retrieve_invitation

Parameter	Type	Required	Description
`invitation_id`	number	yes	The id of the invitation to retrieve

delete_invitation Write

Delete an existing invitation. If you are using a personal access token, you need to have an access level superior or equal to `manager`. Official GitGuardian endpoint: DELETE /v1/invitations/{invitation_id}.

Lua path: app.integrations.gitguardian.delete_invitation
Full name: gitguardian.gitguardian_delete_invitation

Parameter	Type	Required	Description
`invitation_id`	number	yes	The id of the invitation to retrieve

resend_invitation Read

Resend an existing invitation. If you are using a personal access token, you need to have an access level superior or equal to `manager`. Official GitGuardian endpoint: POST /v1/invitations/{invitation_id}/resend.

Lua path: app.integrations.gitguardian.resend_invitation
Full name: gitguardian.gitguardian_resend_invitation

Parameter	Type	Required	Description
`invitation_id`	number	yes	The id of the invitation to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

get_invitation_resource_access Read

Return the permission an invitation has on a resource. If the invitation has an admin access level, it will be the highest possible value. Official GitGuardian endpoint: GET /v1/invitations/{invitation_id}/{resource_type}/{resource_id}.

Lua path: app.integrations.gitguardian.get_invitation_resource_access
Full name: gitguardian.gitguardian_get_invitation_resource_access

Parameter	Type	Required	Description
`invitation_id`	number	yes	The id of the invitation to retrieve
`resource_type`	string	yes	The kind of resource of the access
`resource_id`	number	yes	The id of the resource of the access

set_invitation_resource_access Read

This will create or update a direct access for the invitation on the resource. If the invitation has an administrator access level, it will take precedence over the permission you have given. Official GitGuardian endpoint: PUT /v1/invitations/{invitation_id}/{resource_type}/{resource_id}.

Lua path: app.integrations.gitguardian.set_invitation_resource_access
Full name: gitguardian.gitguardian_set_invitation_resource_access

Parameter	Type	Required	Description
`invitation_id`	number	yes	The id of the invitation to retrieve
`resource_type`	string	yes	The kind of resource of the access
`resource_id`	number	yes	The id of the resource of the access
`body`	object	yes	Request body matching the official GitGuardian OpenAPI schema.

revoke_invitation_resource_access Read

Revoke an invitation access to a resource. This only works for direct accesses. If the access is from the administrator access level of the invitation, a 404 is returned. Official GitGuardian endpoint: DELETE /v1/invitations/{invitation_id}/{resource_type}/{resource_id}.

Lua path: app.integrations.gitguardian.revoke_invitation_resource_access
Full name: gitguardian.gitguardian_revoke_invitation_resource_access

Parameter	Type	Required	Description
`invitation_id`	number	yes	The id of the invitation to retrieve
`resource_type`	string	yes	The kind of resource of the access
`resource_id`	number	yes	The id of the resource of the access
`body`	object	yes	Request body matching the official GitGuardian OpenAPI schema.

list_invitation_secret_incident_access Read

List secret incidents that an invitation has access to. Official GitGuardian endpoint: GET /v1/invitations/{invitation_id}/secret-incidents.

Lua path: app.integrations.gitguardian.list_invitation_secret_incident_access
Full name: gitguardian.gitguardian_list_invitation_secret_incident_access

Parameter	Type	Required	Description
`invitation_id`	number	yes	The id of the invitation to retrieve
`cursor`	string	no	Pagination cursor.
`page`	number	no	Page number.
`per_page`	number	no	Number of items to list per page.
`date_before`	string	no	date_before
`date_after`	string	no	date_after
`assignee_email`	string	no	assignee_email
`assignee_id`	number	no	assignee_id
`status`	string	no	status
`severity`	string	no	severity
`validity`	string	no	validity
`tags`	string	no	tags
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.
`detector_group_name`	string	no	detector_group_name
`ignorer_id`	number	no	ignorer_id
`ignorer_api_token_id`	string	no	ignorer_api_token_id
`resolver_id`	number	no	resolver_id
`resolver_api_token_id`	string	no	resolver_api_token_id
`feedback`	boolean	no	feedback
`only_on_provider_archived_sources`	boolean	no	only_on_provider_archived_sources

list_members Read

List members of the workspace. Official GitGuardian endpoint: GET /v1/members.

Lua path: app.integrations.gitguardian.list_members
Full name: gitguardian.gitguardian_list_members

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`page`	number	no	Page number.
`per_page`	number	no	Number of items to list per page.
`role`	string	no	role
`access_level`	string	no	access_level
`active`	boolean	no	active
`search`	string	no	search
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.

retrieve_member Read

Retrieve an existing workspace member. If you are using a personal access token, you need to have an access level greater or equal to `member`. Official GitGuardian endpoint: GET /v1/members/{member_id}.

Lua path: app.integrations.gitguardian.retrieve_member
Full name: gitguardian.gitguardian_retrieve_member

Parameter	Type	Required	Description
`member_id`	number	yes	The id of the workspace member

delete_member Write

Delete an existing workspace member. If you are using a personal access token, you need to have an access level greater or equal to `manager`. Official GitGuardian endpoint: DELETE /v1/members/{member_id}.

Lua path: app.integrations.gitguardian.delete_member
Full name: gitguardian.gitguardian_delete_member

Parameter	Type	Required	Description
`member_id`	number	yes	The id of the workspace member
`send_email`	boolean	no	Whether to notify the member about the removal.

update_member Write

Update an existing workspace member. If you are using a personal access token, you need to have an access level greater or equal to `manager`. Official GitGuardian endpoint: PATCH /v1/members/{member_id}.

Lua path: app.integrations.gitguardian.update_member
Full name: gitguardian.gitguardian_update_member

Parameter	Type	Required	Description
`member_id`	number	yes	The id of the workspace member
`send_email`	boolean	no	Whether to notify the member about the update.
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

list_member_teams Read

List teams of a workspace member. The response contains the list of teams and a pagination cursor to retrieve the next page. The teams are sorted by id. If you are using a personal access token, you need to have an access level superior or equal to `manager` except if the requested member is yourself. Official GitGuardian endpoint: GET /v1/members/{member_id}/teams.

Lua path: app.integrations.gitguardian.list_member_teams
Full name: gitguardian.gitguardian_list_member_teams

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`search`	string	no	search
`is_global`	boolean	no	is_global
`member_id`	number	yes	The id of the workspace member

get_member_resource_access Read

Return the permission a member has on a resource. The permission is the higher value between the different accesses the member can have (direct access, member's teams accesses, and administrator access). Official GitGuardian endpoint: GET /v1/members/{member_id}/{resource_type}/{resource_id}.

Lua path: app.integrations.gitguardian.get_member_resource_access
Full name: gitguardian.gitguardian_get_member_resource_access

Parameter	Type	Required	Description
`member_id`	number	yes	The id of the workspace member
`resource_type`	string	yes	The kind of resource of the access
`resource_id`	number	yes	The id of the resource of the access

set_member_resource_access Read

This will create or update a direct access for the member on the resource. If the member has higher permission from another source, they will take precedence over those you have given. Official GitGuardian endpoint: PUT /v1/members/{member_id}/{resource_type}/{resource_id}.

Lua path: app.integrations.gitguardian.set_member_resource_access
Full name: gitguardian.gitguardian_set_member_resource_access

Parameter	Type	Required	Description
`member_id`	number	yes	The id of the workspace member
`resource_type`	string	yes	The kind of resource of the access
`resource_id`	number	yes	The id of the resource of the access
`send_email`	boolean	no	Whether to notify the member about the access.
`body`	object	yes	Request body matching the official GitGuardian OpenAPI schema.

revoke_member_resource_access Read

Revoke a member access to a resource. This only works for direct accesses. If the member has only indirect access, a 404 is returned. Official GitGuardian endpoint: DELETE /v1/members/{member_id}/{resource_type}/{resource_id}.

Lua path: app.integrations.gitguardian.revoke_member_resource_access
Full name: gitguardian.gitguardian_revoke_member_resource_access

Parameter	Type	Required	Description
`member_id`	number	yes	The id of the workspace member
`resource_type`	string	yes	The kind of resource of the access
`resource_id`	number	yes	The id of the resource of the access
`body`	object	yes	Request body matching the official GitGuardian OpenAPI schema.

list_member_secret_incident_access Read

List secret incidents that a member has access to. Official GitGuardian endpoint: GET /v1/members/{member_id}/secret-incidents.

Lua path: app.integrations.gitguardian.list_member_secret_incident_access
Full name: gitguardian.gitguardian_list_member_secret_incident_access

Parameter	Type	Required	Description
`member_id`	number	yes	The id of the workspace member
`cursor`	string	no	Pagination cursor.
`page`	number	no	Page number.
`per_page`	number	no	Number of items to list per page.
`date_before`	string	no	date_before
`date_after`	string	no	date_after
`assignee_email`	string	no	assignee_email
`assignee_id`	number	no	assignee_id
`status`	string	no	status
`severity`	string	no	severity
`validity`	string	no	validity
`tags`	string	no	tags
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.
`detector_group_name`	string	no	detector_group_name
`ignorer_id`	number	no	ignorer_id
`ignorer_api_token_id`	string	no	ignorer_api_token_id
`resolver_id`	number	no	resolver_id
`resolver_api_token_id`	string	no	resolver_api_token_id
`feedback`	boolean	no	feedback
`only_on_provider_archived_sources`	boolean	no	only_on_provider_archived_sources

retrieve_member_email_settings Read

Retrieve a member's email settings If you are using a personal access token, you need to have access level greater than `member` to view other member's settings Official GitGuardian endpoint: GET /v1/members/{member_id}/email_notifications.

Lua path: app.integrations.gitguardian.retrieve_member_email_settings
Full name: gitguardian.gitguardian_retrieve_member_email_settings

Parameter	Type	Required	Description
`member_id`	number	yes	The id of the workspace member

update_member_email_settings Write

Update a member's email settings If you are using a personal access token, you need to have access level greater than `member` to edit other member's settings Official GitGuardian endpoint: PATCH /v1/members/{member_id}/email_notifications.

Lua path: app.integrations.gitguardian.update_member_email_settings
Full name: gitguardian.gitguardian_update_member_email_settings

Parameter	Type	Required	Description
`member_id`	number	yes	The id of the workspace member
`send_email`	boolean	no	Whether to notify the member about the update.
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

content_scan Read

Scan provided document content for policy breaks. Request body shouldn't exceed 1MB. This endpoint is stateless and as such will not store in our servers neither the documents nor the secrets found. Official GitGuardian endpoint: POST /v1/scan.

Lua path: app.integrations.gitguardian.content_scan
Full name: gitguardian.gitguardian_content_scan

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

multiple_scan Read

Multiple content scan Official GitGuardian endpoint: POST /v1/multiscan.

Lua path: app.integrations.gitguardian.multiple_scan
Full name: gitguardian.gitguardian_multiple_scan

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

scan_create_incidents Write

Scan content and create incidents Official GitGuardian endpoint: POST /v1/scan/create-incidents.

Lua path: app.integrations.gitguardian.scan_create_incidents
Full name: gitguardian.gitguardian_scan_create_incidents

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

list_secret_detectors Read

List secret detectors. Official GitGuardian endpoint: GET /v1/secret_detectors.

Lua path: app.integrations.gitguardian.list_secret_detectors
Full name: gitguardian.gitguardian_list_secret_detectors

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`is_active`	boolean	no	is_active
`type`	string	no	type
`search`	string	no	search
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.

get_secret_detector Read

Get a secret detector. Official GitGuardian endpoint: GET /v1/secret_detectors/{detector_name}.

Lua path: app.integrations.gitguardian.get_secret_detector
Full name: gitguardian.gitguardian_get_secret_detector

Parameter	Type	Required	Description
`detector_name`	string	yes	Name of the detector to retrieve

get_secret_detail Read

Retrieve the information, including its clear text value, of a secret by its ID. **Prerequisites**: - This endpoint must be enabled in the workspace settings under Security by a workspace admin. - A valid API key with the secrets:read scope. This scope is available only for Personal Access Tokens (PATs). Official GitGuardian endpoint: GET /v1/secrets/{secret_id}.

Lua path: app.integrations.gitguardian.get_secret_detail
Full name: gitguardian.gitguardian_get_secret_detail

Parameter	Type	Required	Description
`secret_id`	number	yes	The ID of the secret to retrieve
`x_privacy_mode`	string	no	When set to `true`, sensitive values in the response are obfuscated (replaced with `<GG>OBFUSCATED</GG>`). Useful for sharing API responses without exposing sensitive data.

quotas Read

Check available scanning calls for this token. Quota is shared between all tokens of a workspace Official GitGuardian endpoint: GET /v1/quotas.

Lua path: app.integrations.gitguardian.quotas
Full name: gitguardian.gitguardian_quotas

Parameter	Type	Required	Description
No parameters.

list_sources Read

List sources known by GitGuardian. Official GitGuardian endpoint: GET /v1/sources.

Lua path: app.integrations.gitguardian.list_sources
Full name: gitguardian.gitguardian_list_sources

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`page`	number	no	Page number.
`per_page`	number	no	Number of items to list per page.
`search`	string	no	search
`last_scan_status`	string	no	last_scan_status
`health`	string	no	health
`type`	string	no	type
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.
`visibility`	string	no	visibility
`external_id`	string	no	external_id
`source_criticality`	string	no	source_criticality
`monitored`	boolean	no	monitored
`provider_metadata_archived`	boolean	no	provider_metadata_archived

retrieve_source Read

Retrieve a source known by GitGuardian. Official GitGuardian endpoint: GET /v1/sources/{source_id}.

Lua path: app.integrations.gitguardian.retrieve_source
Full name: gitguardian.gitguardian_retrieve_source

Parameter	Type	Required	Description
`source_id`	number	yes	The id of the source to retrieve.

update_source Write

Update some source attributes such as monitored status and source criticality. The monitored status can be updated for all source types except Custom Sources. **⚠️ Note**: some sources types are supported on this endpoint, but cannot be updated yet on the dashboard. Business sources can't be updated if your account doesn't have access to them. Official GitGuardian endpoint: PATCH /v1/sources/{source_id}.

Lua path: app.integrations.gitguardian.update_source
Full name: gitguardian.gitguardian_update_source

Parameter	Type	Required	Description
`source_id`	number	yes	The id of the source to retrieve.
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

list_sources_incidents Read

List secret incidents linked to a source. Occurrences are not returned in this route. Official GitGuardian endpoint: GET /v1/sources/{source_id}/incidents/secrets.

Lua path: app.integrations.gitguardian.list_sources_incidents
Full name: gitguardian.gitguardian_list_sources_incidents

Parameter	Type	Required	Description
`source_id`	number	yes	The id of the source to filter on.
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`date_before`	string	no	date_before
`date_after`	string	no	date_after
`assignee_email`	string	no	assignee_email
`assignee_id`	number	no	assignee_id
`status`	string	no	status
`severity`	string	no	severity
`validity`	string	no	validity
`tags`	string	no	tags
`custom_tags`	string	no	custom_tags
`custom_tag_key`	string	no	custom_tag_key
`custom_tag_value`	string	no	custom_tag_value
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.
`detector_group_name`	string	no	detector_group_name
`ignorer_id`	number	no	ignorer_id
`ignorer_api_token_id`	string	no	ignorer_api_token_id
`resolver_id`	number	no	resolver_id
`resolver_api_token_id`	string	no	resolver_api_token_id
`feedback`	boolean	no	feedback
`only_on_provider_archived_sources`	boolean	no	only_on_provider_archived_sources

trigger_source_scans Read

Trigger scans on sources Official GitGuardian endpoint: POST /v1/sources/scans.

Lua path: app.integrations.gitguardian.trigger_source_scans
Full name: gitguardian.gitguardian_trigger_source_scans

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official GitGuardian OpenAPI schema.

list_custom_sources Read

List custom sources for the authenticated account. **⚠️ Beta Version**: This endpoint is in beta and may be subject to changes in future releases. Official GitGuardian endpoint: GET /v1/sources/custom-sources.

Lua path: app.integrations.gitguardian.list_custom_sources
Full name: gitguardian.gitguardian_list_custom_sources

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`page`	number	no	Page number.
`per_page`	number	no	Number of items to list per page.
`search`	string	no	search
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.

create_custom_source Write

Create a new custom source for the authenticated account. **⚠️ Beta Version**: This endpoint is in beta and may be subject to changes in future releases. Official GitGuardian endpoint: POST /v1/sources/custom-sources.

Lua path: app.integrations.gitguardian.create_custom_source
Full name: gitguardian.gitguardian_create_custom_source

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

get_custom_source Read

Get a custom source by ID. **⚠️ Beta Version**: This endpoint is in beta and may be subject to changes in future releases. Official GitGuardian endpoint: GET /v1/sources/custom-sources/{custom_source_id}.

Lua path: app.integrations.gitguardian.get_custom_source
Full name: gitguardian.gitguardian_get_custom_source

Parameter	Type	Required	Description
`custom_source_id`	string	yes	The id of the custom source to retrieve.

update_custom_source Write

Update a custom source's name and description. **⚠️ Beta Version**: This endpoint is in beta and may be subject to changes in future releases. Official GitGuardian endpoint: PATCH /v1/sources/custom-sources/{custom_source_id}.

Lua path: app.integrations.gitguardian.update_custom_source
Full name: gitguardian.gitguardian_update_custom_source

Parameter	Type	Required	Description
`custom_source_id`	string	yes	The id of the custom source to update.
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

delete_custom_source Write

Delete a custom source. This will also delete the related integration if no other sources exist. **⚠️ Beta Version**: This endpoint is in beta and may be subject to changes in future releases. Official GitGuardian endpoint: DELETE /v1/sources/custom-sources/{custom_source_id}.

Lua path: app.integrations.gitguardian.delete_custom_source
Full name: gitguardian.gitguardian_delete_custom_source

Parameter	Type	Required	Description
`custom_source_id`	string	yes	The id of the custom source to delete.

list_developers Read

List developers in the public perimeter. Official GitGuardian endpoint: GET /v1/public-perimeter/developers.

Lua path: app.integrations.gitguardian.list_developers
Full name: gitguardian.gitguardian_list_developers

Parameter	Type	Required	Description
`search`	string	no	search
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.

list_audit_logs Read

List audit logs. Official GitGuardian endpoint: GET /v1/audit_logs.

Lua path: app.integrations.gitguardian.list_audit_logs
Full name: gitguardian.gitguardian_list_audit_logs

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`date_before`	string	no	date_before
`date_after`	string	no	date_after
`event_name`	string	no	Entries matching this event name.
`member_id`	number	no	The id of the member to retrieve.
`member_name`	string	no	Entries matching this member name.
`member_email`	string	no	Entries matching this member email.
`api_token_id`	string	no	Entries matching this API token id.
`ip_address`	string	no	Entries matching this IP address.

list_audit_log_event_names Read

List all the existing event names for audit logs. Use this endpoint to discover which event types are available for filtering when querying audit logs. Official GitGuardian endpoint: GET /v1/audit_logs/event_names.

Lua path: app.integrations.gitguardian.list_audit_log_event_names
Full name: gitguardian.gitguardian_list_audit_log_event_names

Parameter	Type	Required	Description
No parameters.

api_health Read

Check the status of the API and your token without spending your quota. Official GitGuardian endpoint: GET /v1/health.

Lua path: app.integrations.gitguardian.api_health
Full name: gitguardian.gitguardian_api_health

Parameter	Type	Required	Description
No parameters.

list_health_checks Read

List the latest health check per integration instance for the authenticated account. Each entry represents the most recent health check run for a given instance. Results can be filtered by integration type and health status. Official GitGuardian endpoint: GET /v1/health-checks.

Lua path: app.integrations.gitguardian.list_health_checks
Full name: gitguardian.gitguardian_list_health_checks

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`type`	string	no	Filter by integration type.
`status`	string	no	status
`started_at_after`	string	no	started_at_after
`started_at_before`	string	no	started_at_before

list_health_check_instance_history Read

List all historical health check runs for a specific integration instance, ordered by most recent first by default. The `type` path parameter identifies the integration type using its public name. The `instance_id` is the internal ID of the integration instance (e.g. a GitHub installation, GitLab integration, or Slack workspace). Official GitGuardian endpoint: GET /v1/health-checks/{type}/{instance_id}.

Lua path: app.integrations.gitguardian.list_health_check_instance_history
Full name: gitguardian.gitguardian_list_health_check_instance_history

Parameter	Type	Required	Description
`type`	string	yes	The integration type identifier.
`instance_id`	number	yes	The ID of the integration instance.
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`status`	string	no	status
`started_at_after`	string	no	started_at_after
`started_at_before`	string	no	started_at_before
`ordering`	string	no	Sort the results by their field value. The default sort is DESC (most recent first). Prefix with `-` for descending order.

trigger_health_check Read

Enqueue a health check for a specific integration instance. The check runs asynchronously. The response includes a `result_url` pointing to the instance history endpoint pre-filtered to checks started after the trigger time, so you can poll for the result. Returns `429` if a health check was performed too recently for this instance. Official GitGuardian endpoint: POST /v1/health-checks/{type}/{instance_id}/trigger.

Lua path: app.integrations.gitguardian.trigger_health_check
Full name: gitguardian.gitguardian_trigger_health_check

Parameter	Type	Required	Description
`type`	string	yes	The integration type identifier.
`instance_id`	number	yes	The ID of the integration instance.
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

list_teams Read

This endpoint allows you to list all the teams of your workspace. The response contains the list of teams and a pagination cursor to retrieve the next page. The teams are sorted by id. If you are using a personal access token, you need to have an access level superior or equal to `member`. Official GitGuardian endpoint: GET /v1/teams.

Lua path: app.integrations.gitguardian.list_teams
Full name: gitguardian.gitguardian_list_teams

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`is_global`	boolean	no	is_global
`search`	string	no	search
`linked_to_an_external_provider`	boolean	no	linked_to_an_external_provider

create_teams Write

This endpoint allows you to create a team. If you are using a personal access token, you need to have an access level superior or equal to `manager`. If a personal access token is being used, the member is automatically added to the created team with permissions `can_manage` and `full_access` Official GitGuardian endpoint: POST /v1/teams.

Lua path: app.integrations.gitguardian.create_teams
Full name: gitguardian.gitguardian_create_teams

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

retrieve_team Read

Retrieve an existing team. If you are using a personal access token, you need to have an access level greater or equal to `member`. Official GitGuardian endpoint: GET /v1/teams/{team_id}.

Lua path: app.integrations.gitguardian.retrieve_team
Full name: gitguardian.gitguardian_retrieve_team

Parameter	Type	Required	Description
`team_id`	number	yes	The id of the team

delete_team Write

Delete an existing team. 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 deleted. Official GitGuardian endpoint: DELETE /v1/teams/{team_id}.

Lua path: app.integrations.gitguardian.delete_team
Full name: gitguardian.gitguardian_delete_team

Parameter	Type	Required	Description
`team_id`	number	yes	The id of the team

update_team Write

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. Official GitGuardian endpoint: PATCH /v1/teams/{team_id}.

Lua path: app.integrations.gitguardian.update_team
Full name: gitguardian.gitguardian_update_team

Parameter	Type	Required	Description
`team_id`	number	yes	The id of the team
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

list_team_incidents Read

List secret incidents of a particular team. Occurrences are not returned in this route. DEPRECATED: THis endpoint has been replaced by [/v1/teams/{team_id}/secret-incidents](#tag/Teams/operation/list-team-secret-incident-access) Official GitGuardian endpoint: GET /v1/teams/{team_id}/incidents/secrets.

Lua path: app.integrations.gitguardian.list_team_incidents
Full name: gitguardian.gitguardian_list_team_incidents

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`date_before`	string	no	date_before
`date_after`	string	no	date_after
`team_id`	number	yes	The id of the team
`assignee_email`	string	no	assignee_email
`assignee_id`	number	no	assignee_id
`status`	string	no	status
`severity`	string	no	severity
`validity`	string	no	validity
`tags`	string	no	tags
`custom_tags`	string	no	custom_tags
`custom_tag_key`	string	no	custom_tag_key
`custom_tag_value`	string	no	custom_tag_value
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.
`detector_group_name`	string	no	detector_group_name
`ignorer_id`	number	no	ignorer_id
`ignorer_api_token_id`	string	no	ignorer_api_token_id
`resolver_id`	number	no	resolver_id
`resolver_api_token_id`	string	no	resolver_api_token_id
`only_on_provider_archived_sources`	boolean	no	only_on_provider_archived_sources

get_team_resource_access Read

Return the permission a team has on a resource. For the global team, it will always be the highest possible permission. Official GitGuardian endpoint: GET /v1/teams/{team_id}/{resource_type}/{resource_id}.

Lua path: app.integrations.gitguardian.get_team_resource_access
Full name: gitguardian.gitguardian_get_team_resource_access

Parameter	Type	Required	Description
`team_id`	number	yes	The id of the team
`resource_type`	string	yes	The kind of resource of the access
`resource_id`	number	yes	The id of the resource of the access

set_team_resource_access Read

This will create or update a direct access for the team on the resource. If the access to the resource is already given by the team's perimeter, an error is raised. This endpoint is not allowed for the global team. Official GitGuardian endpoint: PUT /v1/teams/{team_id}/{resource_type}/{resource_id}.

Lua path: app.integrations.gitguardian.set_team_resource_access
Full name: gitguardian.gitguardian_set_team_resource_access

Parameter	Type	Required	Description
`team_id`	number	yes	The id of the team
`resource_type`	string	yes	The kind of resource of the access
`resource_id`	number	yes	The id of the resource of the access
`send_email`	boolean	no	Whether to notify the team members about the access.
`body`	object	yes	Request body matching the official GitGuardian OpenAPI schema.

revoke_team_resource_access Read

Revoke the access a team has to a resource. This only works for direct accesses. If the access to the resource is given by the team's perimeter, an error is raised. This endpoint is not allowed for the global team. Official GitGuardian endpoint: DELETE /v1/teams/{team_id}/{resource_type}/{resource_id}.

Lua path: app.integrations.gitguardian.revoke_team_resource_access
Full name: gitguardian.gitguardian_revoke_team_resource_access

Parameter	Type	Required	Description
`team_id`	number	yes	The id of the team
`resource_type`	string	yes	The kind of resource of the access
`resource_id`	number	yes	The id of the resource of the access
`body`	object	yes	Request body matching the official GitGuardian OpenAPI schema.

list_team_secret_incident_access Read

List secret incidents that a team has access to. Official GitGuardian endpoint: GET /v1/teams/{team_id}/secret-incidents.

Lua path: app.integrations.gitguardian.list_team_secret_incident_access
Full name: gitguardian.gitguardian_list_team_secret_incident_access

Parameter	Type	Required	Description
`team_id`	number	yes	The id of the team
`cursor`	string	no	Pagination cursor.
`page`	number	no	Page number.
`per_page`	number	no	Number of items to list per page.
`date_before`	string	no	date_before
`date_after`	string	no	date_after
`assignee_email`	string	no	assignee_email
`assignee_id`	number	no	assignee_id
`status`	string	no	status
`severity`	string	no	severity
`validity`	string	no	validity
`tags`	string	no	tags
`custom_tags`	string	no	custom_tags
`custom_tag_key`	string	no	custom_tag_key
`custom_tag_value`	string	no	custom_tag_value
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.
`detector_group_name`	string	no	detector_group_name
`ignorer_id`	number	no	ignorer_id
`ignorer_api_token_id`	string	no	ignorer_api_token_id
`resolver_id`	number	no	resolver_id
`resolver_api_token_id`	string	no	resolver_api_token_id
`feedback`	boolean	no	feedback
`only_on_provider_archived_sources`	boolean	no	only_on_provider_archived_sources

list_team_invitation Read

List all existing team invitations. If you are using a personal access token, you must have "can manage" permission on the team or be a workspace manager. Official GitGuardian endpoint: GET /v1/teams/{team_id}/team_invitations.

Lua path: app.integrations.gitguardian.list_team_invitation
Full name: gitguardian.gitguardian_list_team_invitation

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`team_id`	number	yes	The id of the team
`invitation_id`	number	no	The id of an invitation to filter on
`is_team_leader`	boolean	no	is_team_leader
`team_permission`	string	no	team_permission
`incident_permission`	string	no	incident_permission

create_team_invitations Write

This endpoint allows you to create a team invitation from an existing team and invitation. If you are using a personal access token, you must have "can manage" permission on the team or be a workspace manager. Official GitGuardian endpoint: POST /v1/teams/{team_id}/team_invitations.

Lua path: app.integrations.gitguardian.create_team_invitations
Full name: gitguardian.gitguardian_create_team_invitations

Parameter	Type	Required	Description
`team_id`	number	yes	The id of the team
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

update_team_invitation Write

Update permissions of a team invitation. If you are using a personal access token, you must have "can manage" permission on the team or be a workspace manager. Official GitGuardian endpoint: PATCH /v1/teams/{team_id}/team_invitations/{team_invitation_id}.

Lua path: app.integrations.gitguardian.update_team_invitation
Full name: gitguardian.gitguardian_update_team_invitation

Parameter	Type	Required	Description
`team_id`	number	yes	The id of the team
`team_invitation_id`	number	yes	The id of the team invitation
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

delete_team_invitation Write

Delete an existing team invitation. If you are using a personal access token, you must have "can manage" permission on the team or be a workspace manager. Official GitGuardian endpoint: DELETE /v1/teams/{team_id}/team_invitations/{team_invitation_id}.

Lua path: app.integrations.gitguardian.delete_team_invitation
Full name: gitguardian.gitguardian_delete_team_invitation

Parameter	Type	Required	Description
`team_id`	number	yes	The id of the team
`team_invitation_id`	number	yes	The id of the team invitation

list_team_memberships Read

List all the memberships of a team. If you are using a personal access token, you need to be a workspace manager or be part of the team. Official GitGuardian endpoint: GET /v1/teams/{team_id}/team_memberships.

Lua path: app.integrations.gitguardian.list_team_memberships
Full name: gitguardian.gitguardian_list_team_memberships

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`team_id`	number	yes	The id of the team
`is_team_leader`	boolean	no	is_team_leader
`team_permission`	string	no	team_permission
`incident_permission`	string	no	incident_permission
`member_id`	number	no	member_id

create_team_membership Write

Add a member to a team. If you are using a personal access token, you must have "can manage" permission on the team or be a workspace manager. Official GitGuardian endpoint: POST /v1/teams/{team_id}/team_memberships.

Lua path: app.integrations.gitguardian.create_team_membership
Full name: gitguardian.gitguardian_create_team_membership

Parameter	Type	Required	Description
`team_id`	number	yes	The id of the team
`send_email`	boolean	no	Whether to notify the member about the team membership.
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

update_team_membership Write

Update permissions of a team membership. If you are using a personal access token, you must have "can manage" permission on the team or be a workspace manager. Official GitGuardian endpoint: PATCH /v1/teams/{team_id}/team_memberships/{team_membership_id}.

Lua path: app.integrations.gitguardian.update_team_membership
Full name: gitguardian.gitguardian_update_team_membership

Parameter	Type	Required	Description
`team_id`	number	yes	The id of the team
`team_membership_id`	number	yes	The id of the team membership
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

delete_team_membership Write

Remove a member from a team. If you are using a personal access token, you must have "can manage" permission on the team or be a workspace manager, or be the member being removed. Official GitGuardian endpoint: DELETE /v1/teams/{team_id}/team_memberships/{team_membership_id}.

Lua path: app.integrations.gitguardian.delete_team_membership
Full name: gitguardian.gitguardian_delete_team_membership

Parameter	Type	Required	Description
`team_id`	number	yes	The id of the team
`team_membership_id`	number	yes	The id of the team membership
`send_email`	boolean	no	Whether to notify the member about the removal from the team.

list_member_team_memberships Read

List team memberships of a workspace member. The response contains the list of team memberships and a pagination cursor to retrieve the next page. The team memberships are sorted by id. If you are using a personal access token, you need to have an access level superior or equal to `manager` except if the requested member is yourself. Official GitGuardian endpoint: GET /v1/members/{member_id}/team_memberships.

Lua path: app.integrations.gitguardian.list_member_team_memberships
Full name: gitguardian.gitguardian_list_member_team_memberships

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`member_id`	number	yes	The id of the workspace member
`team_id`	number	no	The id of a team to filter on

list_team_requests Read

List pending requests of a team. If you are using a personal access token, you must have "can manage" permission on the team or be a workspace manager. Official GitGuardian endpoint: GET /v1/teams/{team_id}/team_requests.

Lua path: app.integrations.gitguardian.list_team_requests
Full name: gitguardian.gitguardian_list_team_requests

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`team_id`	number	yes	The id of the team
`member_id`	number	no	member_id

create_team_request Write

Create an access request to a team. You must be authenticated via a Personal Access Token. You must not already have a pending request on the team, be a member of the team, be a workspace manager or have the restricted access level. Official GitGuardian endpoint: POST /v1/teams/{team_id}/team_requests.

Lua path: app.integrations.gitguardian.create_team_request
Full name: gitguardian.gitguardian_create_team_request

Parameter	Type	Required	Description
`team_id`	number	yes	The id of the team
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

delete_team_request Write

Cancel or decline a team request. If you are using a personal access token, you must have "can manage" permission on the team or be a workspace manager, or be the member who created the request being cancelled. Official GitGuardian endpoint: DELETE /v1/teams/{team_id}/team_requests/{team_request_id}.

Lua path: app.integrations.gitguardian.delete_team_request
Full name: gitguardian.gitguardian_delete_team_request

Parameter	Type	Required	Description
`team_id`	number	yes	The id of the team
`team_request_id`	number	yes	The id of the team request
`send_email`	boolean	no	Whether to notify the member about the request having been denied.

accept_team_request Read

Accept a team request by adding the member to the team. If you are using a personal access token, you must have "can manage" permission on the team or be a workspace manager. Official GitGuardian endpoint: POST /v1/teams/{team_id}/team_requests/{team_request_id}/accept.

Lua path: app.integrations.gitguardian.accept_team_request
Full name: gitguardian.gitguardian_accept_team_request

Parameter	Type	Required	Description
`team_id`	number	yes	The id of the team
`team_request_id`	number	yes	The id of the team request
`send_email`	boolean	no	Whether to notify the member about the request having been accepted.
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

list_member_team_requests Read

List pending team requests of a member. If you are using a personal access token, you need to be either a workspace manager or the member being queried. Official GitGuardian endpoint: GET /v1/members/{member_id}/team_requests.

Lua path: app.integrations.gitguardian.list_member_team_requests
Full name: gitguardian.gitguardian_list_member_team_requests

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`member_id`	number	yes	The id of the workspace member
`team_id`	number	no	team_id

list_team_sources Read

List sources belonging to a team's perimeter. Official GitGuardian endpoint: GET /v1/teams/{team_id}/sources.

Lua path: app.integrations.gitguardian.list_team_sources
Full name: gitguardian.gitguardian_list_team_sources

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`team_id`	number	yes	The id of the team
`search`	string	no	search
`last_scan_status`	string	no	last_scan_status
`health`	string	no	health
`type`	string	no	type
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.
`visibility`	string	no	visibility
`external_id`	string	no	external_id

update_team_sources Write

This endpoint allows you to add and remove sources from the perimeter of a team. If you are using a personal access token, you need to be a workspace manager. Official GitGuardian endpoint: POST /v1/teams/{team_id}/sources.

Lua path: app.integrations.gitguardian.update_team_sources
Full name: gitguardian.gitguardian_update_team_sources

Parameter	Type	Required	Description
`team_id`	number	yes	The id of the team
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

list_honeytoken Read

This endpoint allows you to list all the honeytokens of your workspace. The response contains the list of honeytokens and a pagination cursor to retrieve the next page. The honeytokens are sorted by id. If you are using a personal access token, you need to have an access level superior or equal to `manager`. Official GitGuardian endpoint: GET /v1/honeytokens.

Lua path: app.integrations.gitguardian.list_honeytoken
Full name: gitguardian.gitguardian_list_honeytoken

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`status`	string	no	status
`type`	string	no	type
`search`	string	no	search
`creator_id`	number	no	creator_id
`revoker_id`	number	no	revoker_id
`creator_api_token_id`	string	no	creator_api_token_id
`revoker_api_token_id`	string	no	revoker_api_token_id
`tags`	string	no	tags
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.
`show_token`	boolean	no	show_token
`x_privacy_mode`	string	no	When set to `true`, sensitive values in the response are obfuscated (replaced with `<GG>OBFUSCATED</GG>`). Useful for sharing API responses without exposing sensitive data.

create_honeytoken Write

This endpoint allows you to create a honeytoken of a type. If you are using a personal access token, you need to have an access level superior or equal to `manager`. Official GitGuardian endpoint: POST /v1/honeytokens.

Lua path: app.integrations.gitguardian.create_honeytoken
Full name: gitguardian.gitguardian_create_honeytoken

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

create_honeytoken_with_context Write

This endpoint allows you to create a honeytoken of a given type within a context. The context is a realistic file in which your honeytoken is inserted. If `language`, `project_extensions` and `filename` are not provided, a random context will be generated. Official GitGuardian endpoint: POST /v1/honeytokens/with-context.

Lua path: app.integrations.gitguardian.create_honeytoken_with_context
Full name: gitguardian.gitguardian_create_honeytoken_with_context

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

retrieve_honeytoken Read

Retrieve an existing honeytoken. If you are using a personal access token, you need to have an access level greater or equal to `manager`. Official GitGuardian endpoint: GET /v1/honeytokens/{honeytoken_id}.

Lua path: app.integrations.gitguardian.retrieve_honeytoken
Full name: gitguardian.gitguardian_retrieve_honeytoken

Parameter	Type	Required	Description
`honeytoken_id`	string	yes	The id of the honeytoken to retrieve
`x_privacy_mode`	string	no	When set to `true`, sensitive values in the response are obfuscated (replaced with `<GG>OBFUSCATED</GG>`). Useful for sharing API responses without exposing sensitive data.
`show_token`	boolean	no	show_token

update_honeytoken Write

Update a name or descriptions of an existing honeytoken. Official GitGuardian endpoint: PATCH /v1/honeytokens/{honeytoken_id}.

Lua path: app.integrations.gitguardian.update_honeytoken
Full name: gitguardian.gitguardian_update_honeytoken

Parameter	Type	Required	Description
`honeytoken_id`	string	yes	The id of the honeytoken to retrieve
`x_privacy_mode`	string	no	When set to `true`, sensitive values in the response are obfuscated (replaced with `<GG>OBFUSCATED</GG>`). Useful for sharing API responses without exposing sensitive data.
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

reset_honeytoken Read

Resets a triggered honeytoken. All the associated events will be closed. Official GitGuardian endpoint: POST /v1/honeytokens/{honeytoken_id}/reset.

Lua path: app.integrations.gitguardian.reset_honeytoken
Full name: gitguardian.gitguardian_reset_honeytoken

Parameter	Type	Required	Description
`honeytoken_id`	string	yes	The id of the honeytoken to retrieve
`x_privacy_mode`	string	no	When set to `true`, sensitive values in the response are obfuscated (replaced with `<GG>OBFUSCATED</GG>`). Useful for sharing API responses without exposing sensitive data.
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

revoke_honeytoken Read

Revokes an active or triggered honeytoken. All the associated events will be closed. Official GitGuardian endpoint: POST /v1/honeytokens/{honeytoken_id}/revoke.

Lua path: app.integrations.gitguardian.revoke_honeytoken
Full name: gitguardian.gitguardian_revoke_honeytoken

Parameter	Type	Required	Description
`honeytoken_id`	string	yes	The id of the honeytoken to retrieve
`x_privacy_mode`	string	no	When set to `true`, sensitive values in the response are obfuscated (replaced with `<GG>OBFUSCATED</GG>`). Useful for sharing API responses without exposing sensitive data.
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

list_honeytoken_notes Read

List notes left on a honeytoken in chronological order. Official GitGuardian endpoint: GET /v1/honeytokens/{honeytoken_id}/notes.

Lua path: app.integrations.gitguardian.list_honeytoken_notes
Full name: gitguardian.gitguardian_list_honeytoken_notes

Parameter	Type	Required	Description
`honeytoken_id`	string	yes	The id of the honeytoken to retrieve
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.
`member_id`	number	no	Filter by member id.
`api_token_id`	string	no	Entries matching this API token id.
`search`	string	no	search

create_honeytoken_note Write

Add a note on a honeytoken. Official GitGuardian endpoint: POST /v1/honeytokens/{honeytoken_id}/notes.

Lua path: app.integrations.gitguardian.create_honeytoken_note
Full name: gitguardian.gitguardian_create_honeytoken_note

Parameter	Type	Required	Description
`honeytoken_id`	string	yes	The id of the honeytoken to retrieve
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

update_honeytoken_note Write

Update an existing comment on a honeytoken. Only honeytoken notes created by the current API key can be updated. Official GitGuardian endpoint: PATCH /v1/honeytokens/{honeytoken_id}/notes/{note_id}.

Lua path: app.integrations.gitguardian.update_honeytoken_note
Full name: gitguardian.gitguardian_update_honeytoken_note

Parameter	Type	Required	Description
`honeytoken_id`	string	yes	The id of the honeytoken to retrieve
`note_id`	string	yes	The id of the honeytoken note to update
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

delete_honeytoken_note Write

Delete an existing comment on a honeytoken. Only honeytoken notes created by the current API key can be deleted. Official GitGuardian endpoint: DELETE /v1/honeytokens/{honeytoken_id}/notes/{note_id}.

Lua path: app.integrations.gitguardian.delete_honeytoken_note
Full name: gitguardian.gitguardian_delete_honeytoken_note

Parameter	Type	Required	Description
`honeytoken_id`	string	yes	The id of the honeytoken to retrieve
`note_id`	string	yes	The id of the honeytoken note to update

list_honeytoken_sources Read

List sources where a honeytoken appears. Official GitGuardian endpoint: GET /v1/honeytokens/{honeytoken_id}/sources.

Lua path: app.integrations.gitguardian.list_honeytoken_sources
Full name: gitguardian.gitguardian_list_honeytoken_sources

Parameter	Type	Required	Description
`honeytoken_id`	string	yes	The id of the honeytoken to retrieve
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.
`provider_metadata_archived`	boolean	no	provider_metadata_archived

check_honeytoken_prefixes Read

Bulk prefix lookup for honeytoken HMSL hashes Official GitGuardian endpoint: POST /v1/honeytokens/prefixes.

Lua path: app.integrations.gitguardian.check_honeytoken_prefixes
Full name: gitguardian.gitguardian_check_honeytoken_prefixes

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official GitGuardian OpenAPI schema.

list_honeytokens_events Read

List events related to all honeytokens of the workspace. Official GitGuardian endpoint: GET /v1/honeytokens_events.

Lua path: app.integrations.gitguardian.list_honeytokens_events
Full name: gitguardian.gitguardian_list_honeytokens_events

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'
`honeytoken_id`	string	no	Filter by honeytoken id
`status`	string	no	Filter by status
`ip_address`	string	no	Filter by ip address
`tags`	string	no	tags
`search`	string	no	Search events based on the `data` field content
`x_privacy_mode`	string	no	When set to `true`, sensitive values in the response are obfuscated (replaced with `<GG>OBFUSCATED</GG>`). Useful for sharing API responses without exposing sensitive data.

list_ip_allowlist Read

This endpoint allows you to list all the IP allowlist rules of your workspace. The response contains the list of IP allowlist rules and a pagination cursor to retrieve the next page. If you are using a personal access token, you need to have an access level superior or equal to `manager`. Official GitGuardian endpoint: GET /v1/ip-allowlist.

Lua path: app.integrations.gitguardian.list_ip_allowlist
Full name: gitguardian.gitguardian_list_ip_allowlist

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`search`	string	no	search
`ordering`	string	no	Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.

create_ip_allowlist Write

This endpoint allows you to create an IP allowlist rule. If you are using a personal access token, you need to have an access level superior or equal to `manager`. Official GitGuardian endpoint: POST /v1/ip-allowlist.

Lua path: app.integrations.gitguardian.create_ip_allowlist
Full name: gitguardian.gitguardian_create_ip_allowlist

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

retrieve_ipallowlist Read

Retrieve an existing IP allowlist rule. If you are using a personal access token, you need to have an access level greater or equal to `manager`. Official GitGuardian endpoint: GET /v1/ip-allowlist/{ip_allowlist_rule_id}.

Lua path: app.integrations.gitguardian.retrieve_ipallowlist
Full name: gitguardian.gitguardian_retrieve_ipallowlist

Parameter	Type	Required	Description
`ip_allowlist_rule_id`	string	yes	The id of the IP allowlist rule

update_ipallowlist Write

Update the tag or the IP ranges of an existing IP allowlist rule. Official GitGuardian endpoint: PATCH /v1/ip-allowlist/{ip_allowlist_rule_id}.

Lua path: app.integrations.gitguardian.update_ipallowlist
Full name: gitguardian.gitguardian_update_ipallowlist

Parameter	Type	Required	Description
`ip_allowlist_rule_id`	string	yes	The id of the IP allowlist rule
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

delete_ipallowlist Write

Delete an existing IP allowlist rule. Official GitGuardian endpoint: DELETE /v1/ip-allowlist/{ip_allowlist_rule_id}.

Lua path: app.integrations.gitguardian.delete_ipallowlist
Full name: gitguardian.gitguardian_delete_ipallowlist

Parameter	Type	Required	Description
`ip_allowlist_rule_id`	string	yes	The id of the IP allowlist rule

list_ip_addresses Read

Get GitGuardian's egress IP addresses for IP allowlisting. Use these IP addresses to configure access controls and allow GitGuardian services to access your resources. This includes: - Firewall rules - Application-level IP allowlists - Network security groups - Proxy configurations - VPN allowlists Official GitGuardian endpoint: GET /v1/ips.

Lua path: app.integrations.gitguardian.list_ip_addresses
Full name: gitguardian.gitguardian_list_ip_addresses

Parameter	Type	Required	Description
No parameters.

scim_user_create Read

Create a new workspace member (using SCIM Protocol). Official GitGuardian endpoint: POST /v1/scim/v2/Users.

Lua path: app.integrations.gitguardian.scim_user_create
Full name: gitguardian.gitguardian_scim_user_create

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

scim_user_list Read

List members of the workspace (using SCIM Protocol). Official GitGuardian endpoint: GET /v1/scim/v2/Users.

Lua path: app.integrations.gitguardian.scim_user_list
Full name: gitguardian.gitguardian_scim_user_list

Parameter	Type	Required	Description
`filter`	string	no	Filter users using SCIM filtering DSL.
`start_index`	number	no	The 1-based index of the first result in the current set of list results.
`count`	number	no	Specifies the desired maximum number of query results per page.

scim_user_detail Read

Detail of a workspace member (using SCIM Protocol). Official GitGuardian endpoint: GET /v1/scim/v2/Users/{id}.

Lua path: app.integrations.gitguardian.scim_user_detail
Full name: gitguardian.gitguardian_scim_user_detail

Parameter	Type	Required	Description
`id`	string	yes	id

scim_user_update Read

Update of a workspace member (using SCIM Protocol). Official GitGuardian endpoint: PUT /v1/scim/v2/Users/{id}.

Lua path: app.integrations.gitguardian.scim_user_update
Full name: gitguardian.gitguardian_scim_user_update

Parameter	Type	Required	Description
`id`	string	yes	id
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

scim_user_partial_update Read

Update of a workspace member (using SCIM Protocol). Official GitGuardian endpoint: PATCH /v1/scim/v2/Users/{id}.

Lua path: app.integrations.gitguardian.scim_user_partial_update
Full name: gitguardian.gitguardian_scim_user_partial_update

Parameter	Type	Required	Description
`id`	string	yes	id
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

scim_user_delete Read

Delete a workspace member (using SCIM Protocol). Official GitGuardian endpoint: DELETE /v1/scim/v2/Users/{id}.

Lua path: app.integrations.gitguardian.scim_user_delete
Full name: gitguardian.gitguardian_scim_user_delete

Parameter	Type	Required	Description
`id`	string	yes	id

scim_group_list Read

List groups (teams in GIM) of the workspace using the SCIM Protocol. Official GitGuardian endpoint: GET /v1/scim/v2/Groups.

Lua path: app.integrations.gitguardian.scim_group_list
Full name: gitguardian.gitguardian_scim_group_list

Parameter	Type	Required	Description
`filter`	string	no	Filter groups using the SCIM filtering DSL.
`start_index`	number	no	The 1-based index of the first result in the current set of list results.
`count`	number	no	Specifies the desired maximum number of query results per page.

scim_group_create Read

Create a new group (team in GIM) using the SCIM Protocol. Official GitGuardian endpoint: POST /v1/scim/v2/Groups.

Lua path: app.integrations.gitguardian.scim_group_create
Full name: gitguardian.gitguardian_scim_group_create

Parameter	Type	Required	Description
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

scim_group_detail Read

Detail of a group (team in GIM) using the SCIM Protocol. Official GitGuardian endpoint: GET /v1/scim/v2/Groups/{id}.

Lua path: app.integrations.gitguardian.scim_group_detail
Full name: gitguardian.gitguardian_scim_group_detail

Parameter	Type	Required	Description
`id`	string	yes	id

scim_group_update Read

Update a group (team in GIM) using the SCIM Protocol. Official GitGuardian endpoint: PUT /v1/scim/v2/Groups/{id}.

Lua path: app.integrations.gitguardian.scim_group_update
Full name: gitguardian.gitguardian_scim_group_update

Parameter	Type	Required	Description
`id`	string	yes	id
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

scim_group_partial_update Read

Partially update a group (team in GIM) using the SCIM Protocol. Official GitGuardian endpoint: PATCH /v1/scim/v2/Groups/{id}.

Lua path: app.integrations.gitguardian.scim_group_partial_update
Full name: gitguardian.gitguardian_scim_group_partial_update

Parameter	Type	Required	Description
`id`	string	yes	id
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

scim_group_delete Read

Delete a group (team in GIM) using the SCIM Protocol. Official GitGuardian endpoint: DELETE /v1/scim/v2/Groups/{id}.

Lua path: app.integrations.gitguardian.scim_group_delete
Full name: gitguardian.gitguardian_scim_group_delete

Parameter	Type	Required	Description
`id`	string	yes	id

scim_service_provider_config Read

List the SCIM specification features available on a service provider. Official GitGuardian endpoint: GET /v1/scim/v2/ServiceProviderConfig.

Lua path: app.integrations.gitguardian.scim_service_provider_config
Full name: gitguardian.gitguardian_scim_service_provider_config

Parameter	Type	Required	Description
No parameters.

scim_resource_types_list Read

List of Resource Types Official GitGuardian endpoint: GET /v1/scim/v2/ResourceTypes.

Lua path: app.integrations.gitguardian.scim_resource_types_list
Full name: gitguardian.gitguardian_scim_resource_types_list

Parameter	Type	Required	Description
No parameters.

scim_resource_types_detail Read

Detail of a Resource Types Official GitGuardian endpoint: GET /v1/scim/v2/ResourceTypes/{name}.

Lua path: app.integrations.gitguardian.scim_resource_types_detail
Full name: gitguardian.gitguardian_scim_resource_types_detail

Parameter	Type	Required	Description
`name`	string	yes	name

scim_schema_list Read

List of SCIM Schemas Official GitGuardian endpoint: GET /v1/scim/v2/Schemas.

Lua path: app.integrations.gitguardian.scim_schema_list
Full name: gitguardian.gitguardian_scim_schema_list

Parameter	Type	Required	Description
No parameters.

scim_schema_detail Read

Detail of a Schema Official GitGuardian endpoint: GET /v1/scim/v2/Schemas/{name}.

Lua path: app.integrations.gitguardian.scim_schema_detail
Full name: gitguardian.gitguardian_scim_schema_detail

Parameter	Type	Required	Description
`name`	string	yes	name

list_custom_tags Read

List all existing custom tags. Official GitGuardian endpoint: GET /v1/custom_tags.

Lua path: app.integrations.gitguardian.list_custom_tags
Full name: gitguardian.gitguardian_list_custom_tags

Parameter	Type	Required	Description
`cursor`	string	no	Pagination cursor.
`per_page`	number	no	Number of items to list per page.
`key`	string	no	key

create_custom_tag Write

This endpoint allows you to create a custom tag. Official GitGuardian endpoint: POST /v1/custom_tags.

Lua path: app.integrations.gitguardian.create_custom_tag
Full name: gitguardian.gitguardian_create_custom_tag

Parameter	Type	Required	Description
`body`	object	yes	Request body matching the official GitGuardian OpenAPI schema.

update_custom_tags_key Write

This endpoint allows you to update a key for all custom tags using it. Official GitGuardian endpoint: PATCH /v1/custom_tags.

Lua path: app.integrations.gitguardian.update_custom_tags_key
Full name: gitguardian.gitguardian_update_custom_tags_key

Parameter	Type	Required	Description
`old_key`	string	yes	old_key
`new_key`	string	yes	new_key
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

delete_custom_tags_key Write

This endpoint allows you to delete all custom tags using the given key. Official GitGuardian endpoint: DELETE /v1/custom_tags.

Lua path: app.integrations.gitguardian.delete_custom_tags_key
Full name: gitguardian.gitguardian_delete_custom_tags_key

Parameter	Type	Required	Description
`key`	string	yes	key

get_custom_tag Read

This endpoint allows you to retrieve an existing custom tag. Official GitGuardian endpoint: GET /v1/custom_tags/{custom_tag_id}.

Lua path: app.integrations.gitguardian.get_custom_tag
Full name: gitguardian.gitguardian_get_custom_tag

Parameter	Type	Required	Description
`custom_tag_id`	string	yes	The id of the custom tag

update_custom_tag Write

This endpoint allows you to update a specific custom tag. It replaces the entire custom tag (key and value). This does not impact other custom tags sharing the same key. Official GitGuardian endpoint: PUT /v1/custom_tags/{custom_tag_id}.

Lua path: app.integrations.gitguardian.update_custom_tag
Full name: gitguardian.gitguardian_update_custom_tag

Parameter	Type	Required	Description
`custom_tag_id`	string	yes	The id of the custom tag
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

partial_update_custom_tag Write

This endpoint allows you to partially update a specific custom tag. It updates only the specified fields (key or value), leaving the other fields unchanged. This does not impact other custom tags sharing the same key. Official GitGuardian endpoint: PATCH /v1/custom_tags/{custom_tag_id}.

Lua path: app.integrations.gitguardian.partial_update_custom_tag
Full name: gitguardian.gitguardian_partial_update_custom_tag

Parameter	Type	Required	Description
`custom_tag_id`	string	yes	The id of the custom tag
`body`	object	no	Request body matching the official GitGuardian OpenAPI schema.

delete_custom_tag Write

This endpoint allows you to delete a specific custom tag. This does not impact other custom tags sharing the same key. Official GitGuardian endpoint: DELETE /v1/custom_tags/{custom_tag_id}.

Lua path: app.integrations.gitguardian.delete_custom_tag
Full name: gitguardian.gitguardian_delete_custom_tag

Parameter	Type	Required	Description
`custom_tag_id`	string	yes	The id of the custom tag