Confluent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud Certificate Identity Pools (iam/v2) API

6 actions 6 updates phrasing extends openapi/confluent-certificate-identity-pools-iam-v2-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Confluent's API. It is a proposal applied on top of the contract, not a document Confluent publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools'].get

$.paths['/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools'].post

$.paths['/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}'].get

$.paths['/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}'].put

$.paths['/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluent Cloud Certificate Identity Pools (iam/v2) API
  version: 1.0.0
extends: openapi/confluent-certificate-identity-pools-iam-v2-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity pools for a certificate authority
      effect: read
      questions:
      - Which certificate identity pools are attached to my certificate authority?
      - Can I page through the identity pools of one CA?
      instructions:
      - text: List identity pools for certificate authority {certificate_authority_id}.
        slots:
          certificate_authority_id: path.certificate_authority_id
      - text: Show certificate identity pools on CA {certificate_authority_id}, {page_size} per page.
        slots:
          certificate_authority_id: path.certificate_authority_id
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a certificate identity pool
      effect: write
      questions:
      - How do I map mTLS client certificates to an identity in Confluent Cloud?
      - Can I use a filter expression to decide which certificates join a pool?
      instructions:
      - text: Create identity pool {display_name} on certificate authority {certificate_authority_id}.
        slots:
          display_name: requestBody.display_name
          certificate_authority_id: path.certificate_authority_id
      - text: Create a certificate identity pool {display_name} on CA {certificate_authority_id} with filter {filter}.
        slots:
          display_name: requestBody.display_name
          certificate_authority_id: path.certificate_authority_id
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a certificate identity pool
      effect: read
      questions:
      - What filter and external identifier does a certificate identity pool use?
      - Can I look up one identity pool under a CA?
      instructions:
      - text: Get identity pool {id} on certificate authority {certificate_authority_id}.
        slots:
          id: path.id
          certificate_authority_id: path.certificate_authority_id
      - text: Show the details of certificate identity pool {id} under CA {certificate_authority_id}.
        slots:
          id: path.id
          certificate_authority_id: path.certificate_authority_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a certificate identity pool
      effect: write
      questions:
      - Can I change the certificate filter on an existing identity pool?
      - How do I rename a certificate identity pool?
      instructions:
      - text: Change the filter of identity pool {id} on CA {certificate_authority_id} to {filter}.
        slots:
          id: path.id
          certificate_authority_id: path.certificate_authority_id
          filter: requestBody.filter
      - text: Rename certificate identity pool {id} under CA {certificate_authority_id} to {display_name}.
        slots:
          id: path.id
          certificate_authority_id: path.certificate_authority_id
          display_name: requestBody.display_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/certificate-authorities/{certificate_authority_id}/identity-pools/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a certificate identity pool
      effect: destructive
      questions:
      - How do I remove a certificate identity pool from a CA?
      - What happens to certificate-based access when I delete its identity pool?
      instructions:
      - text: Delete identity pool {id} from certificate authority {certificate_authority_id}.
        slots:
          id: path.id
          certificate_authority_id: path.certificate_authority_id
      - text: Remove certificate identity pool {id} on CA {certificate_authority_id}.
        slots:
          id: path.id
          certificate_authority_id: path.certificate_authority_id
      method: generated
      generated: '2026-09-26'