Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluent Cloud OAuth Tokens (sts/v1) API

2 actions 2 updates phrasing extends openapi/confluent-the-data-streaming-platform-oauth-tokens-sts-v1-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 2

$.info

$.paths['/sts/v1/oauth2/token'].post

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 OAuth Tokens (sts/v1) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-oauth-tokens-sts-v1-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: 1
- target: $.paths['/sts/v1/oauth2/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange an external token for a Confluent token
      effect: write
      questions:
      - How do I use a JWT from my own identity provider to call Confluent Cloud APIs?
      - Can I set how long an exchanged access token stays valid?
      instructions:
      - text: Exchange JWT {subject_token} for a Confluent access token using identity pool {identity_pool_id}.
        slots:
          subject_token: requestBody.subject_token
          identity_pool_id: requestBody.identity_pool_id
      - text: Swap my external token {subject_token} for one expiring in {expires_in} seconds via pool {identity_pool_id}.
        slots:
          subject_token: requestBody.subject_token
          expires_in: requestBody.expires_in
          identity_pool_id: requestBody.identity_pool_id
      method: generated
      generated: '2026-09-26'