data
GitGuardian MCP, CLI, and Lua Integration for AI Agents
GitGuardian integration docs for AI agents: MCP gateway setup, GitGuardian CLI commands, Lua API reference, credentials, and function schemas.GitGuardian for agents
Credentials can be configured manually in web or CLI hosts.
Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.
Agent Surfaces
Machine-Readable Metadata
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
gitguardian.gitguardian_self_retrieve_api_token | Read read | 0 | Retrieve details of the current API token. Official GitGuardian endpoint: GET /v1/api_tokens/self. |
gitguardian.gitguardian_self_delete_api_token | Write write | 0 | Revoke the current API token. Official GitGuardian endpoint: DELETE /v1/api_tokens/self. |
gitguardian.gitguardian_list_api_tokens | Read read | 8 | List all the tokens in the workspace, some filters are available and described below. Official GitGuardian endpoint: GET /v1/api_tokens. |
gitguardian.gitguardian_retrieve_api_token | Read read | 1 | Retrieve details of an API token. Official GitGuardian endpoint: GET /v1/api_tokens/{token_id}. |
gitguardian.gitguardian_delete_api_token | Write write | 1 | Revoke an API token. Official GitGuardian endpoint: DELETE /v1/api_tokens/{token_id}. |
gitguardian.gitguardian_public_jwt_create | Read read | 1 | Create a short lived JWT for authentication to specific GitGuardian services, including HasMySecretLeaked. Official GitGuardian endpoint: POST /v1/auth/jwt. |
gitguardian.gitguardian_list_incidents | Read read | 27 | List secret incidents detected by the GitGuardian dashboard. Occurrences are not returned in this route. Official GitGuardian endpoint: GET /v1/incidents/secrets. |
gitguardian.gitguardian_retrieve_incidents | Read read | 2 | Retrieve secret incident detected by the GitGuardian dashboard with its occurrences. Official GitGuardian endpoint: GET /v1/incidents/secrets/{incident_id}. |
gitguardian.gitguardian_update_secret_incident | Write write | 2 | Update a secret incident. Official GitGuardian endpoint: PATCH /v1/incidents/secrets/{incident_id}. |
gitguardian.gitguardian_retrieve_incidents_leaks | Read read | 1 | 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. |
gitguardian.gitguardian_assign_incident | Write write | 3 | Assign secret incident detected by the GitGuardian dashboard to a workspace member by email. Official GitGuardian endpoint: POST /v1/incidents/secrets/{incident_id}/assign. |
gitguardian.gitguardian_unassign_incident | Read read | 2 | Unassign secret incident from a workspace member by email. Official GitGuardian endpoint: POST /v1/incidents/secrets/{incident_id}/unassign. |
gitguardian.gitguardian_resolve_incident | Read read | 2 | Resolve a secret incident detected by the GitGuardian dashboard. Official GitGuardian endpoint: POST /v1/incidents/secrets/{incident_id}/resolve. |
gitguardian.gitguardian_ignore_incident | Read read | 2 | Ignore a secret incident detected by the GitGuardian dashboard. Official GitGuardian endpoint: POST /v1/incidents/secrets/{incident_id}/ignore. |
gitguardian.gitguardian_reopen_incident | Read read | 2 | Unresolve or unignore a secret incident detected by the GitGuardian dashboard. Official GitGuardian endpoint: POST /v1/incidents/secrets/{incident_id}/reopen. |
gitguardian.gitguardian_share_incident | Read read | 2 | Share a secret incident by creating a public link. Official GitGuardian endpoint: POST /v1/incidents/secrets/{incident_id}/share. |
gitguardian.gitguardian_unshare_incident | Read read | 2 | Unshare a secret incident by revoking its public link. Official GitGuardian endpoint: POST /v1/incidents/secrets/{incident_id}/unshare. |
gitguardian.gitguardian_grant_access_incident | Read read | 2 | 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. |
gitguardian.gitguardian_revoke_access_incident | Read read | 2 | Revoke access to a secret incident Official GitGuardian endpoint: POST /v1/incidents/secrets/{incident_id}/revoke_access. |
gitguardian.gitguardian_list_incident_notes | Read read | 7 | List notes left on a secret incident in chronological order. Official GitGuardian endpoint: GET /v1/incidents/secrets/{incident_id}/notes. |
gitguardian.gitguardian_create_incident_note | Write write | 2 | Add a note on a secret incident. Official GitGuardian endpoint: POST /v1/incidents/secrets/{incident_id}/notes. |
gitguardian.gitguardian_update_incident_note | Write write | 3 | 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}. |
gitguardian.gitguardian_delete_incident_note | Write write | 2 | 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}. |
gitguardian.gitguardian_list_incident_members | Read read | 8 | 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. |
gitguardian.gitguardian_list_incident_teams | Read read | 4 | 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. |
gitguardian.gitguardian_list_incident_invitations | Read read | 4 | 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. |
gitguardian.gitguardian_retrieve_incident_impacted_perimeter | Read read | 1 | 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. |
gitguardian.gitguardian_get_secret_incident_vaults | Read read | 1 | 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. |
gitguardian.gitguardian_list_secret_incident_member_access | Read read | 8 | List members that have access to a secret incident. Official GitGuardian endpoint: GET /v1/secret-incidents/{incident_id}/members. |
gitguardian.gitguardian_list_secret_incident_team_access | Read read | 5 | List teams that have access to a secret incident. Official GitGuardian endpoint: GET /v1/secret-incidents/{incident_id}/teams. |
gitguardian.gitguardian_list_secret_incident_invitation_access | Read read | 6 | List invitations that have access to a secret incident. Official GitGuardian endpoint: GET /v1/secret-incidents/{incident_id}/invitations. |
gitguardian.gitguardian_list_occs | Read read | 21 | List occurrences of secrets in the monitored perimeter. Official GitGuardian endpoint: GET /v1/occurrences/secrets. |
gitguardian.gitguardian_list_severity_rules | Read read | 0 | 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. |
gitguardian.gitguardian_create_code_fix_request | Write write | 1 | 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. |
gitguardian.gitguardian_list_public_incidents | Read read | 26 | List public secret incidents detected by the GitGuardian dashboard. Official GitGuardian endpoint: GET /v1/public-incidents/secrets. |
gitguardian.gitguardian_retrieve_public_incidents | Read read | 2 | Retrieve public secret incident detected by the GitGuardian dashboard Official GitGuardian endpoint: GET /v1/public-incidents/secrets/{incident_id}. |
gitguardian.gitguardian_list_public_secret_occurrences | Read read | 15 | List occurrences of a public secret incident detected by the GitGuardian dashboard Official GitGuardian endpoint: GET /v1/public-incidents/secrets/{incident_id}/occurrences. |
gitguardian.gitguardian_retrieve_public_secret_occurrence | Read read | 2 | 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}. |
gitguardian.gitguardian_resolve_public_incidents | Read read | 2 | Resolve a public secret incident detected by the GitGuardian dashboard. Official GitGuardian endpoint: POST /v1/public-incidents/secrets/{incident_id}/resolve. |
gitguardian.gitguardian_ignore_public_incidents | Read read | 2 | Ignore a public secret incident detected by the GitGuardian dashboard. Official GitGuardian endpoint: POST /v1/public-incidents/secrets/{incident_id}/ignore. |
gitguardian.gitguardian_reopen_public_incidents | Read read | 2 | Reopen a public secret incident that was previously resolved or ignored. Official GitGuardian endpoint: POST /v1/public-incidents/secrets/{incident_id}/reopen. |
gitguardian.gitguardian_assign_public_incidents | Write write | 3 | 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. |
gitguardian.gitguardian_unassign_public_incidents | Read read | 2 | Unassign a public secret incident from its current assignee. Official GitGuardian endpoint: POST /v1/public-incidents/secrets/{incident_id}/unassign. |
gitguardian.gitguardian_share_public_incidents | Read read | 2 | 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. |
gitguardian.gitguardian_unshare_public_incidents | Read read | 2 | Delete a public secret incident's share link. Official GitGuardian endpoint: POST /v1/public-incidents/secrets/{incident_id}/unshare. |
gitguardian.gitguardian_set_severity_public_incidents | Read read | 2 | Set the severity of a public secret incident. Official GitGuardian endpoint: POST /v1/public-incidents/secrets/{incident_id}/set_severity. |
gitguardian.gitguardian_set_custom_tags_public_incidents | Read read | 2 | Set the custom tags of a public secret incident. Official GitGuardian endpoint: POST /v1/public-incidents/secrets/{incident_id}/set_custom_tags. |
gitguardian.gitguardian_list_public_incident_notes | Read read | 6 | List notes left on a public secret incident in chronological order. Official GitGuardian endpoint: GET /v1/public-incidents/secrets/{incident_id}/notes. |
gitguardian.gitguardian_create_public_incident_note | Write write | 2 | Add a note on a public secret incident. Official GitGuardian endpoint: POST /v1/public-incidents/secrets/{incident_id}/notes. |
gitguardian.gitguardian_update_public_incident_note | Write write | 3 | 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}. |
gitguardian.gitguardian_delete_public_incident_note | Write write | 2 | 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}. |
gitguardian.gitguardian_get_public_secret_incident_vaults | Read read | 1 | 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/public-incidents/secrets/{incident_id}/vaults. |
gitguardian.gitguardian_list_invitations | Read read | 4 | 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. |
gitguardian.gitguardian_create_invitations | Write write | 2 | 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. |
gitguardian.gitguardian_retrieve_invitation | Read read | 1 | 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}. |
gitguardian.gitguardian_delete_invitation | Write write | 1 | 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}. |
gitguardian.gitguardian_resend_invitation | Read read | 2 | 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. |
gitguardian.gitguardian_get_invitation_resource_access | Read read | 3 | 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}. |
gitguardian.gitguardian_set_invitation_resource_access | Read read | 4 | 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}. |
gitguardian.gitguardian_revoke_invitation_resource_access | Read read | 4 | 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}. |
gitguardian.gitguardian_list_invitation_secret_incident_access | Read read | 20 | List secret incidents that an invitation has access to. Official GitGuardian endpoint: GET /v1/invitations/{invitation_id}/secret-incidents. |
gitguardian.gitguardian_list_members | Read read | 8 | List members of the workspace. Official GitGuardian endpoint: GET /v1/members. |
gitguardian.gitguardian_retrieve_member | Read read | 1 | 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}. |
gitguardian.gitguardian_delete_member | Write write | 2 | 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}. |
gitguardian.gitguardian_update_member | Write write | 3 | 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}. |
gitguardian.gitguardian_list_member_teams | Read read | 5 | 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. |
gitguardian.gitguardian_get_member_resource_access | Read read | 3 | 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}. |
gitguardian.gitguardian_set_member_resource_access | Read read | 5 | 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}. |
gitguardian.gitguardian_revoke_member_resource_access | Read read | 4 | 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}. |
gitguardian.gitguardian_list_member_secret_incident_access | Read read | 20 | List secret incidents that a member has access to. Official GitGuardian endpoint: GET /v1/members/{member_id}/secret-incidents. |
gitguardian.gitguardian_retrieve_member_email_settings | Read read | 1 | 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. |
gitguardian.gitguardian_update_member_email_settings | Write write | 3 | 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. |
gitguardian.gitguardian_content_scan | Read read | 1 | 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. |
gitguardian.gitguardian_multiple_scan | Read read | 1 | Multiple content scan Official GitGuardian endpoint: POST /v1/multiscan. |
gitguardian.gitguardian_scan_create_incidents | Write write | 1 | Scan content and create incidents Official GitGuardian endpoint: POST /v1/scan/create-incidents. |
gitguardian.gitguardian_list_secret_detectors | Read read | 6 | List secret detectors. Official GitGuardian endpoint: GET /v1/secret_detectors. |
gitguardian.gitguardian_get_secret_detector | Read read | 1 | Get a secret detector. Official GitGuardian endpoint: GET /v1/secret_detectors/{detector_name}. |
gitguardian.gitguardian_get_secret_detail | Read read | 2 | 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}. |
gitguardian.gitguardian_quotas | Read read | 0 | Check available scanning calls for this token. Quota is shared between all tokens of a workspace Official GitGuardian endpoint: GET /v1/quotas. |
gitguardian.gitguardian_list_sources | Read read | 13 | List sources known by GitGuardian. Official GitGuardian endpoint: GET /v1/sources. |
gitguardian.gitguardian_retrieve_source | Read read | 1 | Retrieve a source known by GitGuardian. Official GitGuardian endpoint: GET /v1/sources/{source_id}. |
gitguardian.gitguardian_update_source | Write write | 2 | 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}. |
gitguardian.gitguardian_list_sources_incidents | Read read | 22 | List secret incidents linked to a source. Occurrences are not returned in this route. Official GitGuardian endpoint: GET /v1/sources/{source_id}/incidents/secrets. |
gitguardian.gitguardian_trigger_source_scans | Read read | 1 | Trigger scans on sources Official GitGuardian endpoint: POST /v1/sources/scans. |
gitguardian.gitguardian_list_custom_sources | Read read | 5 | 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. |
gitguardian.gitguardian_create_custom_source | Write write | 1 | 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. |
gitguardian.gitguardian_get_custom_source | Read read | 1 | 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}. |
gitguardian.gitguardian_update_custom_source | Write write | 2 | 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}. |
gitguardian.gitguardian_delete_custom_source | Write write | 1 | 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}. |
gitguardian.gitguardian_list_developers | Read read | 2 | List developers in the public perimeter. Official GitGuardian endpoint: GET /v1/public-perimeter/developers. |
gitguardian.gitguardian_list_audit_logs | Read read | 10 | List audit logs. Official GitGuardian endpoint: GET /v1/audit_logs. |
gitguardian.gitguardian_list_audit_log_event_names | Read read | 0 | 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. |
gitguardian.gitguardian_api_health | Read read | 0 | Check the status of the API and your token without spending your quota. Official GitGuardian endpoint: GET /v1/health. |
gitguardian.gitguardian_list_health_checks | Read read | 6 | 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. |
gitguardian.gitguardian_list_health_check_instance_history | Read read | 8 | 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}. |
gitguardian.gitguardian_trigger_health_check | Read read | 3 | 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. |
gitguardian.gitguardian_list_teams | Read read | 5 | 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. |
gitguardian.gitguardian_create_teams | Write write | 1 | 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. |
gitguardian.gitguardian_retrieve_team | Read read | 1 | 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}. |
gitguardian.gitguardian_delete_team | Write write | 1 | 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}. |
gitguardian.gitguardian_update_team | Write write | 2 | 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}. |
gitguardian.gitguardian_list_team_incidents | Read read | 21 | 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. |
gitguardian.gitguardian_get_team_resource_access | Read read | 3 | 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}. |
gitguardian.gitguardian_set_team_resource_access | Read read | 5 | 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}. |
gitguardian.gitguardian_revoke_team_resource_access | Read read | 4 | 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}. |
gitguardian.gitguardian_list_team_secret_incident_access | Read read | 23 | List secret incidents that a team has access to. Official GitGuardian endpoint: GET /v1/teams/{team_id}/secret-incidents. |
gitguardian.gitguardian_list_team_invitation | Read read | 7 | 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. |
gitguardian.gitguardian_create_team_invitations | Write write | 2 | 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. |
gitguardian.gitguardian_update_team_invitation | Write write | 3 | 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}. |
gitguardian.gitguardian_delete_team_invitation | Write write | 2 | 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}. |
gitguardian.gitguardian_list_team_memberships | Read read | 7 | 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. |
gitguardian.gitguardian_create_team_membership | Write write | 3 | 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. |
gitguardian.gitguardian_update_team_membership | Write write | 3 | 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}. |
gitguardian.gitguardian_delete_team_membership | Write write | 3 | 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}. |
gitguardian.gitguardian_list_member_team_memberships | Read read | 4 | 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. |
gitguardian.gitguardian_list_team_requests | Read read | 4 | 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. |
gitguardian.gitguardian_create_team_request | Write write | 2 | 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. |
gitguardian.gitguardian_delete_team_request | Write write | 3 | 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}. |
gitguardian.gitguardian_accept_team_request | Read read | 4 | 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. |
gitguardian.gitguardian_list_member_team_requests | Read read | 4 | 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. |
gitguardian.gitguardian_list_team_sources | Read read | 10 | List sources belonging to a team's perimeter. Official GitGuardian endpoint: GET /v1/teams/{team_id}/sources. |
gitguardian.gitguardian_update_team_sources | Write write | 2 | 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. |
gitguardian.gitguardian_list_honeytoken | Read read | 13 | 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. |
gitguardian.gitguardian_create_honeytoken | Write write | 1 | 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. |
gitguardian.gitguardian_create_honeytoken_with_context | Write write | 1 | 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. |
gitguardian.gitguardian_retrieve_honeytoken | Read read | 3 | 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}. |
gitguardian.gitguardian_update_honeytoken | Write write | 3 | Update a name or descriptions of an existing honeytoken. Official GitGuardian endpoint: PATCH /v1/honeytokens/{honeytoken_id}. |
gitguardian.gitguardian_reset_honeytoken | Read read | 3 | Resets a triggered honeytoken. All the associated events will be closed. Official GitGuardian endpoint: POST /v1/honeytokens/{honeytoken_id}/reset. |
gitguardian.gitguardian_revoke_honeytoken | Read read | 3 | Revokes an active or triggered honeytoken. All the associated events will be closed. Official GitGuardian endpoint: POST /v1/honeytokens/{honeytoken_id}/revoke. |
gitguardian.gitguardian_list_honeytoken_notes | Read read | 7 | List notes left on a honeytoken in chronological order. Official GitGuardian endpoint: GET /v1/honeytokens/{honeytoken_id}/notes. |
gitguardian.gitguardian_create_honeytoken_note | Write write | 2 | Add a note on a honeytoken. Official GitGuardian endpoint: POST /v1/honeytokens/{honeytoken_id}/notes. |
gitguardian.gitguardian_update_honeytoken_note | Write write | 3 | 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}. |
gitguardian.gitguardian_delete_honeytoken_note | Write write | 2 | 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}. |
gitguardian.gitguardian_list_honeytoken_sources | Read read | 5 | List sources where a honeytoken appears. Official GitGuardian endpoint: GET /v1/honeytokens/{honeytoken_id}/sources. |
gitguardian.gitguardian_check_honeytoken_prefixes | Read read | 1 | Bulk prefix lookup for honeytoken HMSL hashes Official GitGuardian endpoint: POST /v1/honeytokens/prefixes. |
gitguardian.gitguardian_list_honeytokens_events | Read read | 9 | List events related to all honeytokens of the workspace. Official GitGuardian endpoint: GET /v1/honeytokens_events. |
gitguardian.gitguardian_list_ip_allowlist | Read read | 4 | 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. |
gitguardian.gitguardian_create_ip_allowlist | Write write | 1 | 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. |
gitguardian.gitguardian_retrieve_ipallowlist | Read read | 1 | 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}. |
gitguardian.gitguardian_update_ipallowlist | Write write | 2 | Update the tag or the IP ranges of an existing IP allowlist rule. Official GitGuardian endpoint: PATCH /v1/ip-allowlist/{ip_allowlist_rule_id}. |
gitguardian.gitguardian_delete_ipallowlist | Write write | 1 | Delete an existing IP allowlist rule. Official GitGuardian endpoint: DELETE /v1/ip-allowlist/{ip_allowlist_rule_id}. |
gitguardian.gitguardian_list_ip_addresses | Read read | 0 | 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. |
gitguardian.gitguardian_scim_user_create | Read read | 1 | Create a new workspace member (using SCIM Protocol). Official GitGuardian endpoint: POST /v1/scim/v2/Users. |
gitguardian.gitguardian_scim_user_list | Read read | 3 | List members of the workspace (using SCIM Protocol). Official GitGuardian endpoint: GET /v1/scim/v2/Users. |
gitguardian.gitguardian_scim_user_detail | Read read | 1 | Detail of a workspace member (using SCIM Protocol). Official GitGuardian endpoint: GET /v1/scim/v2/Users/{id}. |
gitguardian.gitguardian_scim_user_update | Read read | 2 | Update of a workspace member (using SCIM Protocol). Official GitGuardian endpoint: PUT /v1/scim/v2/Users/{id}. |
gitguardian.gitguardian_scim_user_partial_update | Read read | 2 | Update of a workspace member (using SCIM Protocol). Official GitGuardian endpoint: PATCH /v1/scim/v2/Users/{id}. |
gitguardian.gitguardian_scim_user_delete | Read read | 1 | Delete a workspace member (using SCIM Protocol). Official GitGuardian endpoint: DELETE /v1/scim/v2/Users/{id}. |
gitguardian.gitguardian_scim_group_list | Read read | 3 | List groups (teams in GIM) of the workspace using the SCIM Protocol. Official GitGuardian endpoint: GET /v1/scim/v2/Groups. |
gitguardian.gitguardian_scim_group_create | Read read | 1 | Create a new group (team in GIM) using the SCIM Protocol. Official GitGuardian endpoint: POST /v1/scim/v2/Groups. |
gitguardian.gitguardian_scim_group_detail | Read read | 1 | Detail of a group (team in GIM) using the SCIM Protocol. Official GitGuardian endpoint: GET /v1/scim/v2/Groups/{id}. |
gitguardian.gitguardian_scim_group_update | Read read | 2 | Update a group (team in GIM) using the SCIM Protocol. Official GitGuardian endpoint: PUT /v1/scim/v2/Groups/{id}. |
gitguardian.gitguardian_scim_group_partial_update | Read read | 2 | Partially update a group (team in GIM) using the SCIM Protocol. Official GitGuardian endpoint: PATCH /v1/scim/v2/Groups/{id}. |
gitguardian.gitguardian_scim_group_delete | Read read | 1 | Delete a group (team in GIM) using the SCIM Protocol. Official GitGuardian endpoint: DELETE /v1/scim/v2/Groups/{id}. |
gitguardian.gitguardian_scim_service_provider_config | Read read | 0 | List the SCIM specification features available on a service provider. Official GitGuardian endpoint: GET /v1/scim/v2/ServiceProviderConfig. |
gitguardian.gitguardian_scim_resource_types_list | Read read | 0 | List of Resource Types Official GitGuardian endpoint: GET /v1/scim/v2/ResourceTypes. |
gitguardian.gitguardian_scim_resource_types_detail | Read read | 1 | Detail of a Resource Types Official GitGuardian endpoint: GET /v1/scim/v2/ResourceTypes/{name}. |
gitguardian.gitguardian_scim_schema_list | Read read | 0 | List of SCIM Schemas Official GitGuardian endpoint: GET /v1/scim/v2/Schemas. |
gitguardian.gitguardian_scim_schema_detail | Read read | 1 | Detail of a Schema Official GitGuardian endpoint: GET /v1/scim/v2/Schemas/{name}. |
gitguardian.gitguardian_list_custom_tags | Read read | 3 | List all existing custom tags. Official GitGuardian endpoint: GET /v1/custom_tags. |
gitguardian.gitguardian_create_custom_tag | Write write | 1 | This endpoint allows you to create a custom tag. Official GitGuardian endpoint: POST /v1/custom_tags. |
gitguardian.gitguardian_update_custom_tags_key | Write write | 3 | This endpoint allows you to update a key for all custom tags using it. Official GitGuardian endpoint: PATCH /v1/custom_tags. |
gitguardian.gitguardian_delete_custom_tags_key | Write write | 1 | This endpoint allows you to delete all custom tags using the given key. Official GitGuardian endpoint: DELETE /v1/custom_tags. |
gitguardian.gitguardian_get_custom_tag | Read read | 1 | This endpoint allows you to retrieve an existing custom tag. Official GitGuardian endpoint: GET /v1/custom_tags/{custom_tag_id}. |
gitguardian.gitguardian_update_custom_tag | Write write | 2 | 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}. |
gitguardian.gitguardian_partial_update_custom_tag | Write write | 2 | 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}. |
gitguardian.gitguardian_delete_custom_tag | Write write | 1 | 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}. |