# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Synadia Control Plane / Synadia Cloud Auth Callout API
  version: 1.0.0
extends: openapi/synadia-communications-auth-callout-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: 8
- target: $.paths['/core/beta/auth-callout/{authCalloutId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an auth callout config
      effect: read
      questions:
      - Which control account does an auth callout config use?
      - Can I view the settings of one auth callout configuration?
      instructions:
      - text: Show auth callout config {authCalloutId}.
        slots:
          authCalloutId: path.authCalloutId
      - text: Get the details of auth callout {authCalloutId}.
        slots:
          authCalloutId: path.authCalloutId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/auth-callout/{authCalloutId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an auth callout config
      effect: destructive
      questions:
      - Can I turn off auth callout and restore the control account's JWT?
      - What happens to the control account when I delete an auth callout config?
      instructions:
      - text: Delete auth callout config {authCalloutId}.
        slots:
          authCalloutId: path.authCalloutId
      - text: Remove auth callout {authCalloutId} and update its control account JWT.
        slots:
          authCalloutId: path.authCalloutId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/auth-callout/{authCalloutId}/target-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List auth callout target accounts
      effect: read
      questions:
      - Which accounts can auth callout place users into?
      - Can I see the target accounts configured for an auth callout?
      instructions:
      - text: List target accounts for auth callout {authCalloutId}.
        slots:
          authCalloutId: path.authCalloutId
      - text: Show which accounts auth callout {authCalloutId} issues users for.
        slots:
          authCalloutId: path.authCalloutId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/auth-callout/{authCalloutId}/target-accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a target account to auth callout
      effect: write
      questions:
      - How do I let auth callout issue users into another account?
      - Which signing key groups are needed to configure a target account?
      instructions:
      - text: Add account {account_id} as a target of auth callout {authCalloutId} using signing key group {sk_group_id} and control group {control_account_sk_group_id}.
        slots:
          account_id: requestBody.account_id
          authCalloutId: path.authCalloutId
          sk_group_id: requestBody.sk_group_id
          control_account_sk_group_id: requestBody.control_account_sk_group_id
      - text: Configure {account_id} as a target account on auth callout {authCalloutId}.
        slots:
          account_id: requestBody.account_id
          authCalloutId: path.authCalloutId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/auth-callout/{authCalloutId}/target-accounts/{targetAccountId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a target account from auth callout
      effect: destructive
      questions:
      - Can I stop auth callout from issuing users into a particular account?
      - What's the way to drop one target account entry?
      instructions:
      - text: Remove target account {targetAccountId} from auth callout {authCalloutId}.
        slots:
          targetAccountId: path.targetAccountId
          authCalloutId: path.authCalloutId
      - text: Delete target account entry {targetAccountId} on auth callout {authCalloutId}.
        slots:
          targetAccountId: path.targetAccountId
          authCalloutId: path.authCalloutId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/auth-callout/{authCalloutId}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List auth callout service users
      effect: read
      questions:
      - Which control-account users are allowed to serve auth callout requests?
      - Can I list the NATS users wired up to an auth callout?
      instructions:
      - text: List the auth callout users for {authCalloutId}.
        slots:
          authCalloutId: path.authCalloutId
      - text: Show control account users on auth callout {authCalloutId}.
        slots:
          authCalloutId: path.authCalloutId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/auth-callout/{authCalloutId}/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user that serves auth callout
      effect: write
      questions:
      - How do I authorize my auth service's NATS user to handle callout requests?
      - Can an existing NATS user become an auth callout user?
      instructions:
      - text: Add NATS user {nats_user_id} as an auth callout user on {authCalloutId}.
        slots:
          nats_user_id: requestBody.nats_user_id
          authCalloutId: path.authCalloutId
      - text: Let user {nats_user_id} answer auth callout requests for {authCalloutId}.
        slots:
          nats_user_id: requestBody.nats_user_id
          authCalloutId: path.authCalloutId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/auth-callout/{authCalloutId}/users/{acUserId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an auth callout user
      effect: destructive
      questions:
      - Can I revoke a control account user's access to auth callout?
      - What's the way to remove a user from serving auth callout?
      instructions:
      - text: Remove auth callout user {acUserId} from {authCalloutId}.
        slots:
          acUserId: path.acUserId
          authCalloutId: path.authCalloutId
      - text: Revoke callout access for user {acUserId} on auth callout {authCalloutId}.
        slots:
          acUserId: path.acUserId
          authCalloutId: path.authCalloutId
      method: generated
      generated: '2026-10-01'