Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/confluent-the-data-streaming-platform-identity-providers-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'].get

$.paths['/iam/v2/identity-providers'].post

$.paths['/iam/v2/identity-providers/{id}'].get

$.paths['/iam/v2/identity-providers/{id}'].delete

$.paths['/iam/v2/identity-providers/{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 Providers (iam/v2) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-identity-providers-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List OAuth identity providers
      effect: read
      questions:
      - Which OAuth/OIDC identity providers are registered for my organization?
      - Can I page through all identity providers configured for OAuth?
      instructions:
      - text: List my OAuth identity providers.
      - text: Show the next {page_size} identity providers.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/identity-providers'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an OAuth identity provider
      effect: write
      questions:
      - How do I add my OIDC provider so clients can authenticate with OAuth tokens?
      - What issuer and JWKS URI does a new identity provider need?
      instructions:
      - text: Create identity provider {display_name} with issuer {issuer} and JWKS URI {jwks_uri}.
        slots:
          display_name: requestBody.display_name
          issuer: requestBody.issuer
          jwks_uri: requestBody.jwks_uri
      - text: Register a new OIDC identity provider {display_name} using identity claim {identity_claim}.
        slots:
          display_name: requestBody.display_name
          identity_claim: requestBody.identity_claim
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/identity-providers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an OAuth identity provider
      effect: read
      questions:
      - What issuer and JWKS URI is a specific identity provider using?
      - Can I check whether one identity provider is enabled?
      instructions:
      - text: Show identity provider {id}.
        slots:
          id: path.id
      - text: Read the issuer and state of identity provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/identity-providers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an OAuth identity provider
      effect: destructive
      questions:
      - How do I remove an OAuth identity provider from my org?
      - Can I delete an identity provider that clients no longer use?
      instructions:
      - text: Delete identity provider {id}.
        slots:
          id: path.id
      - text: Remove OAuth identity provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/identity-providers/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an OAuth identity provider
      effect: write
      questions:
      - Can I change the identity claim or description of an existing identity provider?
      - How would I rename an OAuth identity provider?
      instructions:
      - text: Change the identity claim of provider {id} to {identity_claim}.
        slots:
          id: path.id
          identity_claim: requestBody.identity_claim
      - text: Rename identity provider {id} to {display_name}.
        slots:
          id: path.id
          display_name: requestBody.display_name
      method: generated
      generated: '2026-09-26'