Kinde · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kinde Management Directories API

6 actions 6 updates phrasing extends openapi/kinde-directories-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 6

$.info

$.paths['/api/v1/directories'].get

$.paths['/api/v1/directories'].post

$.paths['/api/v1/directories/{directory_id}'].get

$.paths['/api/v1/directories/{directory_id}'].delete

$.paths['/api/v1/directories/{directory_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 Directories API
  version: 1.0.0
extends: openapi/kinde-directories-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['/api/v1/directories'].get
  update:
    x-apievangelist-phrasing:
      intent: List SCIM directories
      effect: read
      questions:
      - Which SCIM directories are syncing users into my account?
      - Can I list the SCIM directories for one organization?
      instructions:
      - text: List all SCIM directories.
      - text: Show SCIM directories for organization {organization_code}.
        slots:
          organization_code: query.organization_code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/directories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a SCIM directory
      effect: write
      questions:
      - How do I set up SCIM provisioning for an organization?
      - What do I need to create a SCIM directory for user and group sync?
      instructions:
      - text: Create a SCIM directory named {directory_name} for organization {org_code} using provider {provider_code}.
        slots:
          directory_name: requestBody.directory_name
          org_code: requestBody.org_code
          provider_code: requestBody.provider_code
      - text: Set up SCIM sync for organization {org_code} with provider {provider_code}, called {directory_name}.
        slots:
          org_code: requestBody.org_code
          provider_code: requestBody.provider_code
          directory_name: requestBody.directory_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/directories/{directory_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SCIM directory
      effect: read
      questions:
      - Can I view the details of one SCIM directory?
      - Where do I check a SCIM directory's configuration?
      instructions:
      - text: Show SCIM directory {directory_id}.
        slots:
          directory_id: path.directory_id
      - text: Get the details of SCIM directory {directory_id}.
        slots:
          directory_id: path.directory_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/directories/{directory_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a SCIM directory
      effect: destructive
      questions:
      - What happens to synced data when I delete a SCIM directory?
      - How do I remove a SCIM directory completely?
      instructions:
      - text: Delete SCIM directory {directory_id}.
        slots:
          directory_id: path.directory_id
      - text: Remove SCIM directory {directory_id} and all its data.
        slots:
          directory_id: path.directory_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/directories/{directory_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a SCIM directory
      effect: write
      questions:
      - Can I rename an existing SCIM directory?
      - What can I change on a SCIM directory after creating it?
      instructions:
      - text: Rename SCIM directory {directory_id} to {directory_name}.
        slots:
          directory_id: path.directory_id
          directory_name: requestBody.directory_name
      - text: Update SCIM directory {directory_id} with the name {directory_name}.
        slots:
          directory_id: path.directory_id
          directory_name: requestBody.directory_name
      method: generated
      generated: '2026-09-26'