Confluent · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-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/identity-providers/{provider_id}/identity-pools'].get
$.paths['/iam/v2/identity-providers/{provider_id}/identity-pools'].post
$.paths['/iam/v2/identity-providers/{provider_id}/identity-pools/{id}'].get
$.paths['/iam/v2/identity-providers/{provider_id}/identity-pools/{id}'].delete
$.paths['/iam/v2/identity-providers/{provider_id}/identity-pools/{id}'].patch

OpenAPI Overlay

Raw ↑
# 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 Identity Pools (iam/v2) API
  version: 1.0.0
extends: openapi/confluent-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/identity-providers/{provider_id}/identity-pools'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity pools for an identity provider
      effect: read
      questions:
      - Which identity pools are set up under one of my OAuth identity providers?
      - How do I page through identity pools for a provider?
      instructions:
      - text: List identity pools under identity provider {provider_id}.
        slots:
          provider_id: path.provider_id
      - text: Show the identity pools for provider {provider_id}.
        slots:
          provider_id: path.provider_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/identity-providers/{provider_id}/identity-pools'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an identity pool
      effect: write
      questions:
      - How do I map OAuth tokens from my identity provider to a Confluent principal?
      - Can I restrict an identity pool with a CEL filter on token claims?
      instructions:
      - text: Create identity pool {display_name} under provider {provider_id} using claim {identity_claim}.
        slots:
          display_name: requestBody.display_name
          provider_id: path.provider_id
          identity_claim: requestBody.identity_claim
      - text: Add an identity pool to provider {provider_id} with filter {filter}.
        slots:
          provider_id: path.provider_id
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/identity-providers/{provider_id}/identity-pools/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an identity pool
      effect: read
      questions:
      - What claim and filter does a particular identity pool use?
      - Can I read one identity pool by its ID?
      instructions:
      - text: Get identity pool {id} under provider {provider_id}.
        slots:
          id: path.id
          provider_id: path.provider_id
      - text: Show the filter and claim for pool {id} of provider {provider_id}.
        slots:
          id: path.id
          provider_id: path.provider_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/identity-providers/{provider_id}/identity-pools/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an identity pool
      effect: destructive
      questions:
      - How do I remove an identity pool I no longer need?
      - Can I delete one pool without deleting its identity provider?
      instructions:
      - text: Delete identity pool {id} from provider {provider_id}.
        slots:
          id: path.id
          provider_id: path.provider_id
      - text: Remove pool {id} under identity provider {provider_id}.
        slots:
          id: path.id
          provider_id: path.provider_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/identity-providers/{provider_id}/identity-pools/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an identity pool
      effect: write
      questions:
      - Can I change the CEL filter on an existing identity pool?
      - Which call renames an identity pool or changes its claim?
      instructions:
      - text: Set the filter on identity pool {id} of provider {provider_id} to {filter}.
        slots:
          id: path.id
          provider_id: path.provider_id
          filter: requestBody.filter
      - text: Rename pool {id} under provider {provider_id} to {display_name}.
        slots:
          id: path.id
          provider_id: path.provider_id
          display_name: requestBody.display_name
      method: generated
      generated: '2026-09-26'