group_compliance_frameworks

Gets or lists a group_compliance_frameworks resource.

Overview

Name	group_compliance_frameworks
Type	Resource
Id	gitlab.security.group_compliance_frameworks

Fields

The following fields are returned by SELECT queries:

list

GraphQL response envelope

Name	Datatype	Description
id	string	Compliance framework ID.
name	string	Name of the compliance framework.
namespace_id	string	Namespace ID.
color	string	Hexadecimal representation of compliance framework's label color.
default_	boolean	Default compliance framework for the group.
description	string	Description of the compliance framework.
edit_path	string	Web UI path to edit the compliance framework.
updated_at	string	Timestamp of when the compliance framework was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	full_path, host	id, search, sort	Compliance frameworks available to projects in this namespace. Generated from the GitLab GraphQL schema field Group.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.

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)
id	string	Global ID of a specific compliance framework to return.
search	string	Search framework with most similar names.
sort	string	Sort compliance frameworks by the criteria.

SELECT examples

list

Compliance frameworks available to projects in this namespace. Generated from the GitLab GraphQL schema field Group.complianceFrameworks (connection of ComplianceFramework nodes).

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