security_configuration

Gets or lists a security_configuration resource.

Overview

Name	security_configuration
Type	Resource
Id	gitlab.security.security_configuration

Fields

The following fields are returned by SELECT queries:

get

GraphQL response envelope

Name	Datatype	Description
auto_devops_enabled	boolean	Whether Auto DevOps is enabled for the project.
auto_devops_help_page_path	string	Path to Auto DevOps help documentation.
auto_devops_path	string	Path to Auto DevOps settings.
can_apply_profiles	boolean	Whether the current user can apply security profiles.
can_enable_auto_devops	boolean	Whether the current user can enable Auto DevOps.
can_manage_attributes	boolean	Whether the current user can manage security attributes.
can_read_attributes	boolean	Whether the current user can read security attributes.
container_scanning_for_registry_enabled	boolean	Whether container scanning for registry is enabled.
gitlab_ci_history_path	string	Path to the GitLab CI configuration file history.
gitlab_ci_present	boolean	Whether a GitLab CI configuration file exists in the project.
group_full_path	string	Full path of the root ancestor group.
group_manage_attributes_path	string	Path to manage group security attributes.
help_page_path	string	Path to application security help documentation.
latest_pipeline_path	string	Path to the latest pipeline on the default branch.
license_configuration_source	string	Source of license configuration.
license_scanning_for_cyclonedx_enabled	boolean	Whether license scanning for CycloneDX SBOM files is enabled.
max_tracked_refs	integer	Maximum number of refs that can be tracked for security scanning.
secret_detection_configuration_path	string	Path to secret detection configuration.
secret_push_protection_available	boolean	Whether secret push protection is available for projects in the instance.
secret_push_protection_enabled	boolean	Whether secret push protection is enabled for the project.
secret_push_protection_enforced	boolean	Whether secret push protection is automatically enforced for all projects in the instance.
security_scan_profiles_licensed	boolean	Whether the project has a license for security scan profiles.
security_training_enabled	boolean	Whether security training is available for the project.
upgrade_path	string	Path to upgrade security features.
user_is_project_admin	boolean	Whether the current user has admin permissions for security testing.
validity_checks_available	boolean	Whether secret detection validity checks are available.
validity_checks_enabled	boolean	Whether secret detection validity checks are enabled.
vulnerability_archive_export_path	string	Path to export vulnerability archives via API.
vulnerability_training_docs_path	string	Path to vulnerability training documentation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project_id, host		Security configuration for the project Generated from the GitLab GraphQL schema field Query.securityConfiguration (SecurityConfiguration).

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
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)
project_id	string	Project to get the security configuration for.

SELECT examples

get

Security configuration for the project Generated from the GitLab GraphQL schema field Query.securityConfiguration (SecurityConfiguration).

SELECT
auto_devops_enabled,
auto_devops_help_page_path,
auto_devops_path,
can_apply_profiles,
can_enable_auto_devops,
can_manage_attributes,
can_read_attributes,
container_scanning_for_registry_enabled,
gitlab_ci_history_path,
gitlab_ci_present,
group_full_path,
group_manage_attributes_path,
help_page_path,
latest_pipeline_path,
license_configuration_source,
license_scanning_for_cyclonedx_enabled,
max_tracked_refs,
secret_detection_configuration_path,
secret_push_protection_available,
secret_push_protection_enabled,
secret_push_protection_enforced,
security_scan_profiles_licensed,
security_training_enabled,
upgrade_path,
user_is_project_admin,
validity_checks_available,
validity_checks_enabled,
vulnerability_archive_export_path,
vulnerability_training_docs_path
FROM gitlab.security.security_configuration
WHERE project_id = '{{ project_id }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;