Kinde · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kinde Management Identities API

4 actions 4 updates phrasing extends openapi/kinde-identities-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Kinde's API. It is a proposal applied on top of the contract, not a document Kinde publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/api/v1/identities/{identity_id}'].get

$.paths['/api/v1/identities/{identity_id}'].delete

$.paths['/api/v1/identities/{identity_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 Kinde Management Identities API
  version: 1.0.0
extends: openapi/kinde-identities-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: 3
- target: $.paths['/api/v1/identities/{identity_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an identity
      effect: read
      questions:
      - Can I look up a single sign-in identity by its ID?
      - What details are stored on a user identity like an email or phone?
      instructions:
      - text: Show identity {identity_id}.
        slots:
          identity_id: path.identity_id
      - text: Get the details of identity {identity_id}.
        slots:
          identity_id: path.identity_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/identities/{identity_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an identity
      effect: destructive
      questions:
      - How do I remove one sign-in identity from a user?
      - Can I delete an old email identity?
      instructions:
      - text: Delete identity {identity_id}.
        slots:
          identity_id: path.identity_id
      - text: Remove the sign-in identity {identity_id}.
        slots:
          identity_id: path.identity_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/identities/{identity_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Make an identity primary
      effect: write
      questions:
      - How do I set an identity as the user's primary one?
      - Can I change which email is primary for a user?
      instructions:
      - text: Make identity {identity_id} the primary identity.
        slots:
          identity_id: path.identity_id
      - text: Set primary on identity {identity_id} to {is_primary}.
        slots:
          identity_id: path.identity_id
          is_primary: requestBody.is_primary
      method: generated
      generated: '2026-09-26'