Confluent | the Data Streaming Platform · OpenAPI Overlay 1.0.0

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

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

$.paths['/iam/v2/users/{id}'].get

$.paths['/iam/v2/users/{id}'].delete

$.paths['/iam/v2/users/{id}'].patch

$.paths['/iam/v2/users/{id}/auth'].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 Users (iam/v2) API
  version: 1.0.0
extends: openapi/confluent-the-data-streaming-platform-users-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/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users in the organization
      effect: read
      questions:
      - Who are the users in my Confluent Cloud organization?
      - Can I page through every user account?
      instructions:
      - text: List users in my organization.
      - text: Show all user accounts.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user
      effect: read
      questions:
      - What email and auth type does a particular user have?
      - Can I look up a user by their ID?
      instructions:
      - text: Get user {id}.
        slots:
          id: path.id
      - text: Show the profile of user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/users/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user and their API keys
      effect: destructive
      questions:
      - What happens to a user's API keys when I remove them?
      - How do I offboard a user from the organization?
      instructions:
      - text: Delete user {id}.
        slots:
          id: path.id
      - text: Offboard user {id} and revoke their cloud and cluster API keys.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/users/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a user's name
      effect: write
      questions:
      - How do I change a user's full name?
      - Can I edit a user's profile details?
      instructions:
      - text: Set the full name of user {id} to {full_name}.
        slots:
          id: path.id
          full_name: requestBody.full_name
      - text: Update user profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iam/v2/users/{id}/auth'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a user's authentication type
      effect: write
      questions:
      - How do I switch a user between SSO and password login?
      - Can I change which auth type a user signs in with?
      instructions:
      - text: Set the auth type of user {id} to {auth_type}.
        slots:
          id: path.id
          auth_type: requestBody.auth_type
      - text: Switch user {id} to SSO sign-in.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'