Confluent | the Data Streaming Platform · 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-the-data-streaming-platform-certificate-identity-pools-iam-v2-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Confluent | the Data Streaming Platform's API. It is a proposal applied on top of the contract, not a document Confluent | the Data Streaming Platform 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-the-data-streaming-platform-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 certificate identity pools
      effect: read
      questions:
      - Which certificate identity pools belong to my certificate authority?
      - Can I page through the identity pools under one certificate authority?
      instructions:
      - text: List identity pools under certificate authority {certificate_authority_id}.
        slots:
          certificate_authority_id: path.certificate_authority_id
      - text: Show {page_size} certificate identity pools for CA {certificate_authority_id}.
        slots:
          page_size: query.page_size
          certificate_authority_id: path.certificate_authority_id
      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 a principal with an identity pool?
      - Can I create a certificate identity pool with a filter on certificate fields?
      instructions:
      - text: Create a certificate identity pool {display_name} under CA {certificate_authority_id}.
        slots:
          display_name: requestBody.display_name
          certificate_authority_id: path.certificate_authority_id
      - text: Add identity pool {display_name} to CA {certificate_authority_id} using filter {filter} and external identifier {external_identifier}.
        slots:
          display_name: requestBody.display_name
          certificate_authority_id: path.certificate_authority_id
          filter: requestBody.filter
          external_identifier: requestBody.external_identifier
      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 principal does a certificate identity pool use?
      - Can I read a single certificate identity pool's settings?
      instructions:
      - text: Show certificate identity pool {id} under CA {certificate_authority_id}.
        slots:
          id: path.id
          certificate_authority_id: path.certificate_authority_id
      - text: Read identity pool {id} from certificate authority {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 would I rename a certificate identity pool?
      instructions:
      - text: Change the filter on certificate identity pool {id} under 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} in 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 certificate authority?
      - Can I delete an identity pool that maps client certificates?
      instructions:
      - text: Delete certificate identity pool {id} under CA {certificate_authority_id}.
        slots:
          id: path.id
          certificate_authority_id: path.certificate_authority_id
      - text: Remove identity pool {id} from certificate authority {certificate_authority_id}.
        slots:
          id: path.id
          certificate_authority_id: path.certificate_authority_id
      method: generated
      generated: '2026-09-26'