COconfluent
Certificate Identity Pools (iam/v2)

Create a Certificate Identity Pool

General Availability

Make a request to create a certificate identity pool.

post/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools

Request

  • Base URL
    https://api.confluent.cloud
  • URL
    https://api.confluent.cloud/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools
  • Auth
    • HTTP basic
    • or HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://api.confluent.cloud/sts/v1/oauth2/token

Path parameters

certificate_authority_idstring required

The Certificate Authority

Query parameters

assigned_resource_ownerstring

Filter a collection by a string search

The resource_id of the principal who will be assigned resource owner on the created certificate identity pool. Principal can be group-mapping (group-xxx), user (u-xxx), service-account (sa-xxx) or identity-pool (pool-xxx).

Request body

api_version'iam/v2'

APIVersion defines the schema version of this representation of a resource.

kind'CertificateIdentityPool'

Kind defines the object this REST resource represents.

idstring

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").

display_namestring required

The name of the IdentityPool.

descriptionstring required

A description of how this IdentityPool is used

external_identifierstring required

The certificate field that will be used to represent the pool's external identifier for audit logging.

filterstring required

A 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).

principalstring

Represents the federated identity associated with this pool.

statestring

The current state of the identity pool

Example request

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/iam/v2/certificate-identity-pools/pool-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/identity-provider=op-12345/identity-pool=pool-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "display_name": "My Identity Pool",
  "description": "Prod Access to Kafka clusters to Release Engineering",
  "external_identifier": "UID",
  "filter": "C=='Canada' && O=='Confluent'",
  "principal": "pool-abc",
  "state": "ENABLED"
}

Response

A Certificate Identity Pool was created.

api_version'iam/v2'

APIVersion defines the schema version of this representation of a resource.

kind'CertificateIdentityPool'

Kind defines the object this REST resource represents.

idstring

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").

display_namestring required

The name of the IdentityPool.

descriptionstring required

A description of how this IdentityPool is used

external_identifierstring required

The certificate field that will be used to represent the pool's external identifier for audit logging.

filterstring required

A 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).

principalstring

Represents the federated identity associated with this pool.

statestring

The current state of the identity pool

Example response

{
  "id": "dlz-f3a90de",
  "metadata": {
    "self": "https://api.confluent.cloud/iam/v2/certificate-identity-pools/pool-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/identity-provider=op-12345/identity-pool=pool-12345",
    "created_at": "2006-01-02T15:04:05-07:00",
    "updated_at": "2006-01-02T15:04:05-07:00",
    "deleted_at": "2006-01-02T15:04:05-07:00"
  },
  "display_name": "My Identity Pool",
  "description": "Prod Access to Kafka clusters to Release Engineering",
  "external_identifier": "UID",
  "filter": "C=='Canada' && O=='Confluent'",
  "principal": "pool-abc",
  "state": "ENABLED"
}

Changes

No recorded changes to this operation across all 7 revisions of this API.