group_mappings

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

Overview

Name	group_mappings
Type	Resource
Id	confluent.iam.group_mappings

Fields

The following fields are returned by SELECT queries:

get_iam_v2_sso_group_mapping

Group Mapping.

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"). (example: dlz-f3a90de)
display_name	string	The name of the group mapping. (example: Application Developers)
api_version	string	APIVersion defines the schema version of this representation of a resource. (iam.v2/sso)
description	string	A description explaining the purpose and use of the group mapping. (example: Admin access to production environment for Engineering)
filter	string	A single group identifier or a condition based on supported CEL operators that defines which groups are included. (example: "kafka" in groups && "all" in groups || "everyone" in groups)
kind	string	Kind defines the object this REST resource represents. (GroupMapping)
metadata	object	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. (example: group-a1b2)
state	string	The current state of the group mapping. (example: ENABLED)

list_iam_v2_sso_group_mappings

Group Mapping.

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"). (example: dlz-f3a90de)
display_name	string	The name of the group mapping. (example: Application Developers)
api_version	string	APIVersion defines the schema version of this representation of a resource. (iam.v2/sso)
description	string	A description explaining the purpose and use of the group mapping. (example: Admin access to production environment for Engineering)
filter	string	A single group identifier or a condition based on supported CEL operators that defines which groups are included. (example: "kafka" in groups && "all" in groups || "everyone" in groups)
kind	string	Kind defines the object this REST resource represents. (GroupMapping)
metadata	object	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. (example: group-a1b2)
state	string	The current state of the group mapping. (example: ENABLED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_iam_v2_sso_group_mapping	select	id		Make a request to read a group mapping.
list_iam_v2_sso_group_mappings	select		page_size, page_token	Retrieve a sorted, filtered, paginated list of all group mappings.
create_iam_v2_sso_group_mapping	insert	display_name, description, filter		Make a request to create a group mapping.
update_iam_v2_sso_group_mapping	update	id		Make a request to update a group mapping.
delete_iam_v2_sso_group_mapping	delete	id		Make a request to delete a group mapping.

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
id	string	The unique identifier for the group mapping.
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.

SELECT examples

get_iam_v2_sso_group_mapping

Make a request to read a group mapping.

SELECT
id,
display_name,
api_version,
description,
filter,
kind,
metadata,
principal,
state
FROM confluent.iam.group_mappings
WHERE id = '{{ id }}' -- required
;

list_iam_v2_sso_group_mappings

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

SELECT
id,
display_name,
api_version,
description,
filter,
kind,
metadata,
principal,
state
FROM confluent.iam.group_mappings
WHERE page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_iam_v2_sso_group_mapping

Make a request to create a group mapping.

INSERT INTO confluent.iam.group_mappings (
display_name,
description,
filter
)
SELECT 
'{{ display_name }}' /* required */,
'{{ description }}' /* required */,
'{{ filter }}' /* required */
RETURNING
id,
display_name,
api_version,
description,
filter,
kind,
metadata,
principal,
state
;

Manifest

# Description fields are for documentation purposes
- name: group_mappings
props:
  - name: display_name
    value: "{{ display_name }}"
    description: |
      The name of the group mapping.
  - name: description
    value: "{{ description }}"
    description: |
      A description explaining the purpose and use of the group mapping.
  - name: filter
    value: "{{ filter }}"
    description: |
      A single group identifier or a condition based on [supported CEL operators](https://docs.confluent.io/cloud/current/access-management/authenticate/sso/group-mapping/overview.html#supported-cel-operators-for-group-mapping) that defines which groups are included.

UPDATE examples

update_iam_v2_sso_group_mapping

Make a request to update a group mapping.

UPDATE confluent.iam.group_mappings
SET 
display_name = '{{ display_name }}',
description = '{{ description }}',
filter = '{{ filter }}'
WHERE 
id = '{{ id }}' --required
RETURNING
id,
display_name,
api_version,
description,
filter,
kind,
metadata,
principal,
state;

DELETE examples

delete_iam_v2_sso_group_mapping

Make a request to delete a group mapping.

DELETE FROM confluent.iam.group_mappings
WHERE id = '{{ id }}' --required
;