group_scan_execution_policies
Gets or lists a group_scan_execution_policies resource.
Overview​
| Name | group_scan_execution_policies |
| Type | Resource |
| Id | gitlab.security.group_scan_execution_policies |
Fields​
The following fields are returned by SELECT queries:
- list
GraphQL response envelope
| Name | Datatype | Description |
|---|---|---|
name | string | Name of the policy. |
description | string | Description of the policy. |
edit_path | string | URL of policy edit page. |
enabled | boolean | Indicates whether the policy is enabled. |
updated_at | string | Timestamp of when the policy YAML was last updated. |
yaml | string | YAML definition of the policy. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | full_path, host | deduplicate_policies, include_unscoped, relationship | Scan Execution Policies of the namespace. Generated from the GitLab GraphQL schema field Group.scanExecutionPolicies (connection of ScanExecutionPolicy nodes). |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
full_path | string | Full path of the group, for example gitlab-org |
host | string | GitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST) |
deduplicate_policies | boolean | Remove duplicate policies when the same policy is applied via multiple routes. |
include_unscoped | boolean | Filter policies that are scoped to the project. |
relationship | string | Filter policies by the given policy relationship. Default is DIRECT. |
SELECT examples​
- list
Scan Execution Policies of the namespace. Generated from the GitLab GraphQL schema field Group.scanExecutionPolicies (connection of ScanExecutionPolicy nodes).
SELECT
name,
description,
edit_path,
enabled,
updated_at,
yaml
FROM gitlab.security.group_scan_execution_policies
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND deduplicate_policies = '{{ deduplicate_policies }}'
AND include_unscoped = '{{ include_unscoped }}'
AND relationship = '{{ relationship }}'
;