# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Vendasta User API
  version: 1.0.0
extends: openapi/vendasta-user-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: 9
- target: $.paths['/user/{user_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a platform user by user ID
      effect: read
      questions:
      - Can I pull a Vendasta user's profile with just their user ID, outside of SCIM?
      - What details come back for a single platform user looked up by user ID?
      instructions:
      - text: Get platform user {user_id}.
        slots:
          user_id: path.user_id
      - text: Show the user record for user ID {user_id} from the user endpoint.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/{user_id}/permissions/{account_id}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check whether a user can access an account
      effect: read
      questions:
      - Is there a quick check for whether a given user has permission on a business account?
      - Can I verify a user's access to one account without fetching any data?
      instructions:
      - text: Check if user {user_id} has access to account {account_id}.
        slots:
          user_id: path.user_id
          account_id: path.account_id
      - text: Confirm that {user_id} is permitted to open business account {account_id}.
        slots:
          user_id: path.user_id
          account_id: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{namespace}/Users'].get
  update:
    x-apievangelist-phrasing:
      intent: Search or list users under a partner
      effect: read
      questions:
      - Can I find partner users by a SCIM filter such as userName or email?
      - What's the way to page through every user a Vendasta partner has?
      - Which sort and paging options exist when listing SCIM users?
      instructions:
      - text: List all users in partner namespace {namespace}.
        slots:
          namespace: path.namespace
      - text: Search users in {namespace} matching the SCIM filter {filter}.
        slots:
          namespace: path.namespace
          filter: query.filter
      - text: Show {count} users from {namespace} sorted by {sortBy}.
        slots:
          count: query.count
          namespace: path.namespace
          sortBy: query.sortBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{namespace}/Users'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision a new user via SCIM
      effect: write
      questions:
      - How do I provision a brand-new user for my partner account through SCIM?
      - What fields are required when creating a SCIM user, like userName and email?
      instructions:
      - text: Create a user {userName} with email {emails} in partner {namespace}.
        slots:
          userName: requestBody.userName
          emails: requestBody.emails
          namespace: path.namespace
      - text: Provision a new SCIM user named {name} under {namespace} with external ID {externalId}.
        slots:
          name: requestBody.name
          namespace: path.namespace
          externalId: requestBody.externalId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{namespace}/Users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one user by ID
      effect: read
      questions:
      - Can I look up a single SCIM user when I already know their user ID?
      - What does the user record for a known Vendasta user ID contain?
      instructions:
      - text: Fetch user {id} from partner namespace {namespace}.
        slots:
          id: path.id
          namespace: path.namespace
      - text: Show me the SCIM profile of user {id} in {namespace}.
        slots:
          id: path.id
          namespace: path.namespace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{namespace}/Users/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace all attributes of a user
      effect: write
      questions:
      - If I overwrite a SCIM user entirely, do attributes I leave out get blanked?
      - Is there a way to replace a user's whole record rather than patch one field?
      instructions:
      - text: Replace user {id} in {namespace} with a full record using username {userName}.
        slots:
          id: path.id
          namespace: path.namespace
          userName: requestBody.userName
      - text: Overwrite every attribute of user {id} in {namespace}, setting emails to {emails}.
        slots:
          id: path.id
          namespace: path.namespace
          emails: requestBody.emails
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{namespace}/Users/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user
      effect: destructive
      questions:
      - Can I deprovision and remove a user from my partner account through SCIM?
      - What happens when I delete a SCIM user by ID?
      instructions:
      - text: Delete user {id} from partner namespace {namespace}.
        slots:
          id: path.id
          namespace: path.namespace
      - text: Remove SCIM user {id} in {namespace} permanently.
        slots:
          id: path.id
          namespace: path.namespace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{namespace}/Users/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch selected attributes of a user
      effect: write
      questions:
      - Can I change just one attribute on a user and leave the rest untouched?
      - Which PATCH operations can I send to modify part of a SCIM user?
      instructions:
      - text: Patch user {id} in {namespace} with the operations {Operations}.
        slots:
          id: path.id
          namespace: path.namespace
          Operations: requestBody.Operations
      - text: Deactivate only the active flag on user {id} in {namespace} with a partial update.
        slots:
          id: path.id
          namespace: path.namespace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{namespace}/Me'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the user behind the current token
      effect: read
      questions:
      - Who am I according to the access token I'm calling the SCIM API with?
      - Where does the SCIM Me resource redirect to for the calling user?
      instructions:
      - text: Look up the user tied to my access token in namespace {namespace}.
        slots:
          namespace: path.namespace
      - text: Follow the Me redirect for {namespace} and show my own user record.
        slots:
          namespace: path.namespace
      method: generated
      generated: '2026-10-01'