Confluent | the Data Streaming Platform · 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-the-data-streaming-platform-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/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

# 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-the-data-streaming-platform-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 my OAuth identity provider?
      - Can I see all identity pools mapping external identities to access?
      instructions:
      - text: List identity pools for identity provider {provider_id}.
        slots:
          provider_id: path.provider_id
      - text: Show every identity pool under 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 tokens from my external identity provider to Confluent Cloud access?
      - Can I filter which external identities join an identity pool using a claim expression?
      instructions:
      - text: Create identity pool {display_name} under provider {provider_id} with filter {filter}.
        slots:
          display_name: requestBody.display_name
          provider_id: path.provider_id
          filter: requestBody.filter
      - text: Add an identity pool to provider {provider_id} using identity claim {identity_claim}.
        slots:
          provider_id: path.provider_id
          identity_claim: requestBody.identity_claim
      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 filter and identity claim does one of my identity pools use?
      - Is an identity pool enabled or disabled?
      instructions:
      - text: Get identity pool {id} under provider {provider_id}.
        slots:
          provider_id: path.provider_id
          id: path.id
      - text: Show the filter on identity pool {id} for provider {provider_id}.
        slots:
          provider_id: path.provider_id
          id: path.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 so those external identities lose access?
      - Can I delete an identity pool from an identity provider?
      instructions:
      - text: Delete identity pool {id} under provider {provider_id}.
        slots:
          provider_id: path.provider_id
          id: path.id
      - text: Remove identity pool {id} from identity provider {provider_id}.
        slots:
          provider_id: path.provider_id
          id: path.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:
      - How do I change the claim filter on an existing identity pool?
      - Can I rename or disable an identity pool?
      instructions:
      - text: Change the filter on identity pool {id} under provider {provider_id} to {filter}.
        slots:
          provider_id: path.provider_id
          id: path.id
          filter: requestBody.filter
      - text: Rename identity pool {id} for provider {provider_id} to {display_name}.
        slots:
          provider_id: path.provider_id
          id: path.id
          display_name: requestBody.display_name
      method: generated
      generated: '2026-09-26'