COconfluent
Certificate Identity Pools (iam/v2)

List of Certificate Identity Pools

General Availability

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

get/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

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

Certificate Identity Pool.

api_version'iam/v2' required

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

kind'CertificateIdentityPoolList' required

Kind defines the object this REST resource represents.

Example response

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