group_mappings

Creates, updates, deletes, gets or lists a group_mappings resource.

Overview

Name	group_mappings
Type	Resource
Id	confluent.iam.group_mappings

Fields

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").
description	string	A description explaining the purpose and use of the group mapping.
api_version	string	APIVersion defines the schema version of this representation of a resource.
display_name	string	The name of the group mapping.
filter	string	A single group identifier or a condition based on supported CEL operators that defines which groups are included.
kind	string	Kind defines the object this REST resource represents.
metadata	``	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
principal	string	The unique federated identity associated with this group mapping.
state	string	The current state of the group mapping.

Methods

Name	Accessible by	Required Params	Description
get_iam_v2sso_group_mapping	SELECT	id	Make a request to read a group mapping.
list_iam_v2sso_group_mappings	SELECT		Retrieve a sorted, filtered, paginated list of all group mappings.
create_iam_v2sso_group_mapping	INSERT		Make a request to create a group mapping.
delete_iam_v2sso_group_mapping	DELETE	id	Make a request to delete a group mapping.
update_iam_v2sso_group_mapping	UPDATE	id	Make a request to update a group mapping.

SELECT examples

Retrieve a sorted, filtered, paginated list of all group mappings.

SELECT
id,
description,
api_version,
display_name,
filter,
kind,
metadata,
principal,
state
FROM confluent.iam.group_mappings
;

INSERT example

Use the following StackQL query and manifest file to create a new group_mappings resource.

All Properties

/*+ create */
INSERT INTO confluent.iam.group_mappings (
data__display_name,
data__description,
data__filter
)
SELECT 
'{{ display_name }}',
'{{ description }}',
'{{ filter }}'
;

Manifest

- name: group_mappings
  props:
    - name: display_name
      value: string
    - name: description
      value: string
    - name: filter
      value: string

UPDATE example

Updates a group_mappings resource.

/*+ update */
UPDATE confluent.iam.group_mappings
SET 
display_name = '{{ display_name }}',
description = '{{ description }}',
filter = '{{ filter }}'
WHERE 
id = '{{ id }}';

DELETE example

Deletes the specified group_mappings resource.

/*+ delete */
DELETE FROM confluent.iam.group_mappings
WHERE id = '{{ id }}';