Sign in
Identity Pools (iam/v2)

List of Identity Pools

General Availability

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

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

Path parameters

provider_idstring required

The Provider

Query parameters

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

Identity Pool.

api_version'iam/v2' required

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

kind'IdentityPoolList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/iam/v2/identity-pools",
    "last": "https://api.confluent.cloud/iam/v2/identity-pools?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/iam/v2/identity-pools?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/iam/v2/identity-pools?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "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.