Skip to main content

project_compliance_frameworks

Gets or lists a project_compliance_frameworks resource.

Overview​

Nameproject_compliance_frameworks
TypeResource
Idgitlab.security.project_compliance_frameworks

Fields​

The following fields are returned by SELECT queries:

GraphQL response envelope

NameDatatypeDescription
idstringCompliance framework ID.
namestringName of the compliance framework.
namespace_idstringNamespace ID.
colorstringHexadecimal representation of compliance framework's label color.
default_booleanDefault compliance framework for the group.
descriptionstringDescription of the compliance framework.
edit_pathstringWeb UI path to edit the compliance framework.
updated_atstringTimestamp of when the compliance framework was last updated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectfull_path, hostsortCompliance frameworks associated with the project. Generated from the GitLab GraphQL schema field Project.complianceFrameworks (connection of ComplianceFramework 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.

NameDatatypeDescription
full_pathstringFull path of the project, for example gitlab-org/gitlab
hoststringGitLab 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)
sortstringSort compliance frameworks by the criteria.

SELECT examples​

Compliance frameworks associated with the project. Generated from the GitLab GraphQL schema field Project.complianceFrameworks (connection of ComplianceFramework nodes).

SELECT
id,
name,
namespace_id,
color,
default_,
description,
edit_path,
updated_at
FROM gitlab.security.project_compliance_frameworks
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND sort = '{{ sort }}'
;