Skip to main content

certificate_identity_pools

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

Overview

Namecertificate_identity_pools
TypeResource
Idconfluent.iam.certificate_identity_pools

Fields

NameDatatypeDescription
idstringID 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").
descriptionstringA description of how this IdentityPool is used
api_versionstringAPIVersion defines the schema version of this representation of a resource.
display_namestringThe name of the IdentityPool.
external_identifierstringThe certificate field that will be used to represent the pool's external identifier for audit logging.
filterstringA filter expression in Supported Common Expression Language (CEL) that specifies which identities can authenticate using your certificate identity pool (see CEL filter for mTLS for more details).
kindstringKind defines the object this REST resource represents.
metadata``ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
principalstringRepresents the federated identity associated with this pool.
statestringThe current state of the identity pool

Methods

NameAccessible byRequired ParamsDescription
get_iam_v2certificate_identity_poolSELECTcertificate_authority_id, idLimited Availability Make a request to read a certificate identity pool.
list_iam_v2certificate_identity_poolsSELECTcertificate_authority_idLimited Availability Retrieve a sorted, filtered, paginated list of all certificate identity pools.
create_iam_v2certificate_identity_poolINSERTcertificate_authority_idLimited Availability Make a request to create a certificate identity pool.
delete_iam_v2certificate_identity_poolDELETEcertificate_authority_id, idLimited Availability Make a request to delete a certificate identity pool.
update_iam_v2certificate_identity_poolEXECcertificate_authority_id, idLimited Availability Make a request to update a certificate identity pool.

SELECT examples

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

SELECT
id,
description,
api_version,
display_name,
external_identifier,
filter,
kind,
metadata,
principal,
state
FROM confluent.iam.certificate_identity_pools
WHERE certificate_authority_id = '{{ certificate_authority_id }}';

INSERT example

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

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

DELETE example

Deletes the specified certificate_identity_pools resource.

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