# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Treasure Data Users API
  version: 1.0.0
extends: openapi/treasure-data-users-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: 9
- target: $.paths['/user/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List users in the account
      effect: read
      questions:
      - Who are all the users on my Treasure Data account?
      - Can I get a list of everyone with access to the account?
      instructions:
      - text: List all users in the account.
      - text: Show everyone with access to the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/show'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the authenticated user
      effect: read
      questions:
      - Which user does my API key belong to?
      - How do I see details about the currently logged-in user?
      instructions:
      - text: Show my user profile.
      - text: Tell me which user my API key belongs to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/remove/{user_email}'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from the account
      effect: destructive
      questions:
      - How do I delete a user who has left the team?
      - Can an admin remove a user by email?
      instructions:
      - text: Remove user {user_email}.
        slots:
          user_email: path.user_email
      - text: Delete the user account for {user_email}.
        slots:
          user_email: path.user_email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/create_with_sso/{user_first_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user who signs in with SSO
      effect: write
      questions:
      - How can an admin add a new user that authenticates through SSO?
      - What do I need to create an SSO user, like an email and identifier?
      instructions:
      - text: Create SSO user {user_first_name} with email {email} and identifier {identifier}.
        slots:
          user_first_name: path.user_first_name
          email: requestBody.email
          identifier: requestBody.identifier
      - text: Add {user_first_name} ({email}) as a new SSO user with identifier {identifier}.
        slots:
          user_first_name: path.user_first_name
          email: requestBody.email
          identifier: requestBody.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/enforce_sso/{user_email}'].post
  update:
    x-apievangelist-phrasing:
      intent: Require a user to sign in with SSO
      effect: write
      questions:
      - Can I make SSO mandatory for a specific user?
      - How do I force one user to log in only through SSO?
      instructions:
      - text: Enforce SSO login for {user_email}.
        slots:
          user_email: path.user_email
      - text: Make SSO mandatory for {user_email}.
        slots:
          user_email: path.user_email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/enable_sso/{user_email}'].post
  update:
    x-apievangelist-phrasing:
      intent: Allow a user to sign in with SSO
      effect: write
      questions:
      - How do I permit a user to log in with SSO as an option?
      - Can SSO be turned on for a single user without making it mandatory?
      instructions:
      - text: Enable SSO login for {user_email}.
        slots:
          user_email: path.user_email
      - text: Let {user_email} optionally sign in with SSO.
        slots:
          user_email: path.user_email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/disable_sso/{user_email}'].post
  update:
    x-apievangelist-phrasing:
      intent: Prohibit a user from signing in with SSO
      effect: write
      questions:
      - Can I block a user from using SSO to log in?
      - How do I turn SSO off for a particular user?
      instructions:
      - text: Disable SSO login for {user_email}.
        slots:
          user_email: path.user_email
      - text: Block {user_email} from signing in with SSO.
        slots:
          user_email: path.user_email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/delegated_admin/add/{user_email}'].post
  update:
    x-apievangelist-phrasing:
      intent: Make a user a delegated admin
      effect: write
      questions:
      - How do I give a user delegated admin rights?
      - Can I promote someone to delegated admin by email?
      instructions:
      - text: Promote {user_email} to delegated admin.
        slots:
          user_email: path.user_email
      - text: Give {user_email} delegated admin rights.
        slots:
          user_email: path.user_email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/delegated_admin/remove/{user_email}'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a user's delegated admin role
      effect: destructive
      questions:
      - How do I take delegated admin rights away from a user?
      - Can I demote a delegated admin back to a regular user?
      instructions:
      - text: Demote {user_email} from delegated admin.
        slots:
          user_email: path.user_email
      - text: Take delegated admin rights away from {user_email}.
        slots:
          user_email: path.user_email
      method: generated
      generated: '2026-09-26'