API Evangelist conversational phrasing for Lucid Users API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lucid Users API
  version: 1.0.0
extends: openapi/lucid-users-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: 11
- target: $.paths['/v1/users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user on my account
      effect: read
      questions:
      - What details can I see about a specific user on my Lucid account?
      - Can I look up a teammate by their Lucid user ID through the REST API?
      instructions:
      - text: Get user {id} from my account.
        slots:
          id: path.id
      - text: Show the account details for user ID {id} via the standard REST API.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List all users on my account
      effect: read
      questions:
      - Who are all the users on my Lucid account?
      - Can I pull a full roster of everyone on the account from the REST API?
      instructions:
      - text: List every user on my account.
      - text: Give me the full user roster for our account using the REST users endpoint.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new user to my account
      effect: write
      questions:
      - How do I add a new person to our Enterprise account with their name and email?
      - Do new users get a license automatically when I create them?
      instructions:
      - text: Create a user for {email} named {firstName} {lastName}.
        slots:
          email: requestBody.email
          firstName: requestBody.firstName
          lastName: requestBody.lastName
      - text: Add {firstName} {lastName} ({email}) to the account with roles {roles}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          email: requestBody.email
          roles: requestBody.roles
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/users/searchByEmail'].post
  update:
    x-apievangelist-phrasing:
      intent: Find users by email address
      effect: read
      questions:
      - Which users on my account match these email addresses?
      - Is the email lookup for users case-insensitive?
      instructions:
      - text: Find the users with emails {emails}.
        slots:
          emails: requestBody.emails
      - text: Look up account users by email address {emails}.
        slots:
          emails: requestBody.emails
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/users/me/profile'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my own user profile
      effect: read
      questions:
      - Who am I signed in as in Lucid?
      - What profile information does the authenticated user have?
      instructions:
      - text: Show my user profile.
      - text: Get the profile of the user this token belongs to.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/Users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user via SCIM provisioning
      effect: read
      questions:
      - How do I fetch a single user record through SCIM?
      - Can my identity provider read one Lucid user via the SCIM endpoint?
      instructions:
      - text: Get SCIM user {id}.
        slots:
          id: path.id
      - text: Read the SCIM record for user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/Users/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a user's attributes via SCIM
      effect: write
      questions:
      - How do I deactivate a user through SCIM by replacing their record?
      - Can I overwrite a user's name, title and phone numbers with a SCIM PUT?
      instructions:
      - text: Replace the SCIM record for user {id}, setting active to {active}.
        slots:
          id: path.id
          active: requestBody.active
      - text: Overwrite SCIM user {id} with userName {userName} and job title {title}.
        slots:
          id: path.id
          userName: requestBody.userName
          title: requestBody.title
      method: generated
      generated: '2026-10-01'
- target: $.paths['/Users/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Hard-delete a user via SCIM
      effect: destructive
      questions:
      - Can I permanently delete a user through SCIM instead of deactivating them?
      - Which users can't be hard-deleted from the account?
      instructions:
      - text: Hard delete user {id} through SCIM.
        slots:
          id: path.id
      - text: Permanently remove SCIM user {id} from the account.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/Users/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch a user's attributes via SCIM
      effect: write
      questions:
      - Can I change just a few attributes of a user with a SCIM PATCH?
      - What does a SCIM patch operation to deactivate a user look like?
      instructions:
      - text: Apply SCIM patch operations {Operations} to user {id}.
        slots:
          id: path.id
          Operations: requestBody.Operations
      - text: Patch SCIM user {id} with schemas {schemas} and operations {Operations}.
        slots:
          id: path.id
          schemas: requestBody.schemas
          Operations: requestBody.Operations
      method: generated
      generated: '2026-10-01'
- target: $.paths['/Users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users via SCIM with filters
      effect: read
      questions:
      - How can my provisioning tool list all users through SCIM?
      - Can I filter SCIM users by userName or choose which attributes come back?
      instructions:
      - text: List SCIM users matching filter {filter}.
        slots:
          filter: query.filter
      - text: Get {count} SCIM users starting at index {startIndex}.
        slots:
          count: query.count
          startIndex: query.startIndex
      - text: List SCIM users returning only attributes {attributes}.
        slots:
          attributes: query.attributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/Users'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision a new user via SCIM
      effect: write
      questions:
      - How do I provision a new Lucid user from my identity provider over SCIM?
      - Can I set an external ID when provisioning a user over SCIM?
      instructions:
      - text: Provision a SCIM user with userName {userName}.
        slots:
          userName: requestBody.userName
      - text: Create a SCIM user {userName} with external ID {externalId}.
        slots:
          userName: requestBody.userName
          externalId: requestBody.externalId
      method: generated
      generated: '2026-10-01'