identity_pools

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

Overview

Name	identity_pools
Type	Resource
Id	confluent.iam.identity_pools

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 of how this IdentityPool is used
api_version	string	APIVersion defines the schema version of this representation of a resource.
display_name	string	The name of the IdentityPool.
filter	string	A filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your identity pool (see Set identity pool filters for more details).
identity_claim	string	The JSON Web Token (JWT) claim to extract the authenticating identity to Confluent resources from (see Registered Claim Names for more details). This appears in the audit log records, showing, for example, that "identity Z used identity pool X to access topic A".
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	Represents the federated identity associated with this pool.
state	string	The current state of the identity pool

Methods

Name	Accessible by	Required Params	Description
get_iam_v2identity_pool	SELECT	id, provider_id	Make a request to read an identity pool.
list_iam_v2identity_pools	SELECT	provider_id	Retrieve a sorted, filtered, paginated list of all identity pools.
create_iam_v2identity_pool	INSERT	provider_id	Make a request to create an identity pool.
delete_iam_v2identity_pool	DELETE	id, provider_id	Make a request to delete an identity pool.
update_iam_v2identity_pool	UPDATE	id, provider_id	Make a request to update an identity pool.

SELECT examples

Retrieve a sorted, filtered, paginated list of all identity pools.

SELECT
id,
description,
api_version,
display_name,
filter,
identity_claim,
kind,
metadata,
principal,
state
FROM confluent.iam.identity_pools
WHERE provider_id = '{{ provider_id }}';

INSERT example

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

All Properties

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

Manifest

- name: identity_pools
  props:
    - name: provider_id
      value: string
    - name: display_name
      value: string
    - name: description
      value: string
    - name: identity_claim
      value: string
    - name: filter
      value: string

UPDATE example

Updates a identity_pools resource.

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

DELETE example

Deletes the specified identity_pools resource.

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