Sign in
Identity Pools (iam/v2)

Create an Identity Pool

General Availability

Make a request to create an identity pool.

post/iam/v2/identity-providers/{provider_id}/identity-pools

Path parameters

provider_idstring required

The Provider

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 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'IdentityPool'

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

identity_claimstring required

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

filterstring required

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

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/identity-pools/ip-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/identity-pool=ip-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",
  "identity_claim": "claims.sub",
  "filter": "claims.aud==\"confluent\" && claims.group!=\"invalid_group\"",
  "principal": "pool-abc",
  "state": "ENABLED"
}

Response

An Identity Pool was created.

api_version'iam/v2'

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

kind'IdentityPool'

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

identity_claimstring required

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

filterstring required

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

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/identity-pools/ip-12345",
    "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/identity-pool=ip-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",
  "identity_claim": "claims.sub",
  "filter": "claims.aud==\"confluent\" && claims.group!=\"invalid_group\"",
  "principal": "pool-abc",
  "state": "ENABLED"
}

Changes

No recorded changes to this endpoint across all 4 revisions of this API.