Confluent · 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-identity-providers-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'].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

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 Providers (iam/v2) API
  version: 1.0.0
extends: openapi/confluent-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 identity providers are configured for my organization?
      - Can I page through all identity providers?
      instructions:
      - text: List my identity providers.
      - text: Show identity providers, {page_size} per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/identity-providers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an OAuth identity provider
      effect: write
      questions:
      - How do I let OAuth/OIDC tokens from my identity provider authenticate to Confluent Cloud?
      - 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: Add an OIDC identity provider called {display_name} for issuer {issuer}.
        slots:
          display_name: requestBody.display_name
          issuer: requestBody.issuer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/identity-providers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an identity provider
      effect: read
      questions:
      - What issuer and identity claim does a configured identity provider use?
      - Can I see one identity provider's settings?
      instructions:
      - text: Get identity provider {id}.
        slots:
          id: path.id
      - text: Show the issuer and JWKS settings 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 identity provider
      effect: destructive
      questions:
      - How do I stop trusting tokens from an identity provider?
      - Can I remove an OAuth identity provider entirely?
      instructions:
      - text: Delete identity provider {id}.
        slots:
          id: path.id
      - text: Remove OAuth identity provider {id} from my organization.
        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 identity provider
      effect: write
      questions:
      - Can I change the identity claim or JWKS URI of an existing identity provider?
      - How do I rename an identity provider?
      instructions:
      - text: Change the JWKS URI of identity provider {id} to {jwks_uri}.
        slots:
          id: path.id
          jwks_uri: requestBody.jwks_uri
      - text: Set the identity claim of existing identity provider {id} to {identity_claim}.
        slots:
          id: path.id
          identity_claim: requestBody.identity_claim
      method: generated
      generated: '2026-09-26'