# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for One Auth Kit API
  version: 1.0.0
extends: openapi/integration-os-authkit-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v1/authkit'].get
  update:
    x-apievangelist-phrasing:
      intent: Check default OAuth setup for a connector
      effect: read
      questions:
      - Does a connector definition fall back to the default OAuth credentials in AuthKit?
      - Can I check whether AuthKit OAuth is configured for a connector in a given environment?
      instructions:
      - text: Check the default OAuth configuration for connector definition {connection_definition_id} in {environment}, active {active}.
        slots:
          connection_definition_id: requestBody.connectionDefinitionId
          environment: requestBody.environment
          active: requestBody.active
      - text: Verify whether {connection_definition_id} uses default OAuth credentials.
        slots:
          connection_definition_id: requestBody.connectionDefinitionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/authkit'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an AuthKit session for an end user
      effect: write
      questions:
      - How do I launch the AuthKit connect flow for one of my end users?
      - Can I tie an AuthKit session to a user identity and group?
      instructions:
      - text: Initialize AuthKit for end user {identity}.
        slots:
          identity: requestBody.identity
      - text: Start an AuthKit session for {identity} of type {identity_type} in group {group}.
        slots:
          identity: requestBody.identity
          identity_type: requestBody.identityType
          group: requestBody.group
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/authkit/dashboard'].post
  update:
    x-apievangelist-phrasing:
      intent: Open the AuthKit dashboard session
      effect: write
      questions:
      - How do I start an AuthKit session from the dashboard in my personal scope?
      - Can I label a dashboard-initiated AuthKit session?
      instructions:
      - text: Initialize a personal AuthKit dashboard session.
      - text: Start a dashboard AuthKit session labelled {label} for identity {identity}.
        slots:
          label: requestBody.label
          identity: requestBody.identity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/authkit/organizations/{org_id}/dashboard'].post
  update:
    x-apievangelist-phrasing:
      intent: Open an org's AuthKit dashboard session
      effect: write
      questions:
      - How do I open an AuthKit dashboard session for my organization?
      - Can an organization-level AuthKit dashboard session carry tags?
      instructions:
      - text: Initialize the AuthKit dashboard for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Start org {org_id}'s AuthKit dashboard session for identity {identity}, tagged {tags}.
        slots:
          org_id: path.org_id
          identity: requestBody.identity
          tags: requestBody.tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/authkit/organizations/{org_id}/projects/{project_id}/dashboard'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a project's AuthKit dashboard session
      effect: write
      questions:
      - How do I start an AuthKit dashboard session scoped to one project?
      - Can a project-level AuthKit dashboard session be named?
      instructions:
      - text: Initialize the AuthKit dashboard for project {project_id} in org {org_id}.
        slots:
          project_id: path.project_id
          org_id: path.org_id
      - text: Start project {project_id}'s AuthKit dashboard session named {name} under organization {org_id}.
        slots:
          project_id: path.project_id
          name: requestBody.name
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/authkit/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate an AuthKit token for an end user
      effect: write
      questions:
      - How do I mint an AuthKit token my frontend can use to open the connect UI?
      - Can I generate an AuthKit token for a specific customer identity?
      instructions:
      - text: Generate an AuthKit token for identity {identity}.
        slots:
          identity: requestBody.identity
      - text: Mint an AuthKit token for {identity} ({identity_type}) labelled {label}.
        slots:
          identity: requestBody.identity
          identity_type: requestBody.identityType
          label: requestBody.label
      method: generated
      generated: '2026-10-01'