# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Workfront User API
  version: 1.0.0
extends: openapi/adobe-suite-user-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: 32
- target: $.paths['/user/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Workfront user by ID
      effect: read
      questions:
      - What details can I pull for a single Workfront user if I know their ID?
      - Can I limit which fields come back when I look up one user?
      instructions:
      - text: Show me the user with ID {id}.
        slots:
          id: path.id
      - text: Get user {id} and return only the fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a single user's profile
      effect: write
      questions:
      - How do I change a single user's details in Workfront?
      - Can I edit one person's user record and get back the updated fields?
      instructions:
      - text: Update the user record {id}.
        slots:
          id: path.id
      - text: Edit user {id} and return the fields {fields} afterward.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single user
      effect: destructive
      questions:
      - How do I remove one user from Workfront?
      - Is there a force flag for deleting a user who still has linked work?
      instructions:
      - text: Delete the user {id}.
        slots:
          id: path.id
      - text: Force delete user {id} using force={force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several users by their IDs
      effect: read
      questions:
      - Can I fetch a batch of Workfront users in one call by listing their IDs?
      - What is the way to look up multiple specific users at once?
      instructions:
      - text: Get the users with IDs {id}.
        slots:
          id: query.id
      - text: Fetch users {id} returning just the fields {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user'].put
  update:
    x-apievangelist-phrasing:
      intent: Update many users in one request
      effect: write
      questions:
      - Can I bulk edit a group of users in a single request?
      - How do I apply the same change to several user records at once?
      instructions:
      - text: Bulk update these user records in one request.
      - text: Bulk edit the users and return fields {fields} for each.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new user
      effect: write
      questions:
      - How do I add a new person as a user in Workfront?
      - Can I create user accounts through the API?
      instructions:
      - text: Create a new Workfront user.
      - text: Add a user and return the fields {fields} for the new record.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several users at once
      effect: destructive
      questions:
      - Can I delete a whole list of users in one call?
      - How do I bulk remove users by their IDs?
      instructions:
      - text: Delete all of the users with IDs {id}.
        slots:
          id: query.id
      - text: Bulk delete users {id} with force set to {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/replace'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace users with another user
      effect: write
      questions:
      - How do I hand over a departing user's assignments to someone else?
      - Can I swap several users out for a single replacement user?
      instructions:
      - text: Replace users {id} with user {replacementID}.
        slots:
          id: query.id
          replacementID: query.replacementID
      - text: Reassign everything from user {id} to {replacementID}.
        slots:
          id: query.id
          replacementID: query.replacementID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count users matching filters
      effect: read
      questions:
      - How many users are in my Workfront instance?
      - Can I get just a count of users that match certain conditions?
      instructions:
      - text: Count all users.
      - text: Count the users that match {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search users with filters
      effect: read
      questions:
      - How do I search for users by name, role or other attributes?
      - Can I page and sort through user search results?
      instructions:
      - text: Search users matching {filters}.
        slots:
          filters: query.filters
      - text: Find users matching {filters} with list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report over users
      effect: read
      questions:
      - Can I get an aggregated report of users grouped by some field?
      - What does a user report return compared with a plain search?
      instructions:
      - text: Run a user report.
      - text: Build a user report filtered by {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/addMobileDevice'].put
  update:
    x-apievangelist-phrasing:
      intent: Register a mobile device for push
      effect: write
      questions:
      - How do I register a phone to receive Workfront mobile notifications?
      - Can I attach a mobile device token to my user?
      instructions:
      - text: Register mobile device token {token} of type {deviceType}.
        slots:
          token: query.token
          deviceType: query.deviceType
      - text: Add my mobile device with token {token}.
        slots:
          token: query.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/assignUserToken'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign a registration token to a user
      effect: write
      questions:
      - How do I generate a registration token for a new user?
      - Can I assign a user token so someone can finish signing up?
      instructions:
      - text: Assign a user token to user {ID}.
        slots:
          ID: query.ID
      - text: Create a registration token for user {ID}.
        slots:
          ID: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/calculateDataExtension'].put
  update:
    x-apievangelist-phrasing:
      intent: Recalculate a user's custom data
      effect: write
      questions:
      - How do I recalculate calculated custom fields on a user?
      - Can I refresh the data extension values for one user?
      instructions:
      - text: Recalculate the custom data fields for user {ID}.
        slots:
          ID: query.ID
      - text: Refresh calculated custom form values on user {ID}.
        slots:
          ID: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/clearAllApiKeys'].put
  update:
    x-apievangelist-phrasing:
      intent: Revoke all API keys
      effect: destructive
      questions:
      - How do I invalidate every API key in the instance at once?
      - Can I clear all existing API keys in one action?
      instructions:
      - text: Clear all API keys.
      - text: Revoke every issued API key right now.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/clearApiKey'].put
  update:
    x-apievangelist-phrasing:
      intent: Revoke my current API key
      effect: destructive
      questions:
      - How do I clear my own API key?
      - Can I invalidate just the API key I am currently using?
      instructions:
      - text: Clear my API key.
      - text: Revoke the API key on my own user.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/completeUserRegistration'].put
  update:
    x-apievangelist-phrasing:
      intent: Complete a new user's registration
      effect: write
      questions:
      - How does an invited user finish registering with a name and password?
      - What do I need to complete registration for a new user?
      instructions:
      - text: Complete registration for user {ID} with token {token} and password {newPassword}.
        slots:
          ID: query.ID
          token: query.token
          newPassword: query.newPassword
      - text: Finish registering {firstName} {lastName} as user {ID} with title {title}.
        slots:
          firstName: query.firstName
          lastName: query.lastName
          ID: query.ID
          title: query.title
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/generateApiKey'].put
  update:
    x-apievangelist-phrasing:
      intent: Generate a new API key
      effect: write
      questions:
      - How do I generate a fresh API key for my user?
      - Can I create a new API key to replace my old one?
      instructions:
      - text: Generate a new API key for me.
      - text: Create a fresh API key on my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/getApiKey'].put
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a user's API key
      effect: read
      questions:
      - Where can I see the current API key for a user?
      - Can I retrieve an existing API key without generating a new one?
      instructions:
      - text: Get the API key for user {ID}.
        slots:
          ID: query.ID
      - text: Show me the existing API key of user {ID}.
        slots:
          ID: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/getAvailableActions'].put
  update:
    x-apievangelist-phrasing:
      intent: List actions I can take on an object type
      effect: read
      questions:
      - Which actions am I allowed to perform on a given object type?
      - Can I check the available actions for projects or tasks?
      instructions:
      - text: List the actions available to me for object type {objCode}.
        slots:
          objCode: query.objCode
      - text: Show what I am allowed to do on {objCode} records.
        slots:
          objCode: query.objCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/getUserAccessPermissionsByObjCode'].put
  update:
    x-apievangelist-phrasing:
      intent: Check access permissions on objects
      effect: read
      questions:
      - What access do I have on specific objects of a given type?
      - Can I look up my permissions for a list of object IDs?
      instructions:
      - text: Get my access permissions on {objCode} objects {ids}.
        slots:
          objCode: query.objCode
          ids: query.ids
      - text: Check permissions for objects {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/getUserCustomLabels'].put
  update:
    x-apievangelist-phrasing:
      intent: Get a user's custom labels
      effect: read
      questions:
      - Where do I find the custom labels configured for my user?
      - Can I read the custom label names shown to a user?
      instructions:
      - text: Get my user custom labels.
      - text: Show the custom labels configured for my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/getUsersAvailableTime'].put
  update:
    x-apievangelist-phrasing:
      intent: Get users' available time in a date range
      effect: read
      questions:
      - How much available time do specific users have between two dates?
      - Can I check team capacity for a date range?
      instructions:
      - text: Get available time for users {userIDs} from {fromDate} to {toDate}.
        slots:
          userIDs: query.userIDs
          fromDate: query.fromDate
          toDate: query.toDate
      - text: Show how much time users {userIDs} have free.
        slots:
          userIDs: query.userIDs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/hasAnyAccess'].put
  update:
    x-apievangelist-phrasing:
      intent: Check if I have any access to an action
      effect: read
      questions:
      - Do I have any access to perform a given action on an object type?
      - Can I test whether my user has rights for an action type?
      instructions:
      - text: Check whether I have {actionType} access on {objCode}.
        slots:
          actionType: query.actionType
          objCode: query.objCode
      - text: Tell me if I have any access to {objCode}.
        slots:
          objCode: query.objCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/hasGrantLoginAsAccess'].put
  update:
    x-apievangelist-phrasing:
      intent: Check login-as grant access for a user
      effect: read
      questions:
      - Can I tell whether I am allowed to log in as another user?
      - Does this user have grant login-as access?
      instructions:
      - text: Check if I have login-as access for user {ID}.
        slots:
          ID: query.ID
      - text: Verify grant login-as rights for user {ID}.
        slots:
          ID: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/isUserAdmin'].put
  update:
    x-apievangelist-phrasing:
      intent: Check if a user administers another user
      effect: read
      questions:
      - Is one user an admin over another user?
      - Can I verify the user-admin relationship between two people?
      instructions:
      - text: Check if {adminID} is a user admin for {userID}.
        slots:
          adminID: query.adminID
          userID: query.userID
      - text: Confirm that user {adminID} administers user {userID}.
        slots:
          adminID: query.adminID
          userID: query.userID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/isUserTerminologyActive'].put
  update:
    x-apievangelist-phrasing:
      intent: Check if custom terminology is active
      effect: read
      questions:
      - Is custom terminology turned on for my user?
      - How can I tell whether user terminology is active?
      instructions:
      - text: Check whether user terminology is active.
      - text: Tell me if custom terminology is enabled for me.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/removeMobileDevice'].put
  update:
    x-apievangelist-phrasing:
      intent: Unregister a mobile device
      effect: destructive
      questions:
      - How do I stop push notifications to an old phone?
      - Can I remove a registered mobile device token?
      instructions:
      - text: Remove the mobile device with token {token}.
        slots:
          token: query.token
      - text: Unregister device token {token} from my user.
        slots:
          token: query.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/resetRopgPassword'].put
  update:
    x-apievangelist-phrasing:
      intent: Reset the ROPG password
      effect: write
      questions:
      - How do I reset my resource owner password grant password?
      - Can I set a new ROPG password through the API?
      instructions:
      - text: Reset my ROPG password to {newPassword}.
        slots:
          newPassword: query.newPassword
      - text: Set a new resource owner grant password {newPassword}.
        slots:
          newPassword: query.newPassword
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/sendInvitationEmail'].put
  update:
    x-apievangelist-phrasing:
      intent: Send an invitation email to a user
      effect: write
      questions:
      - How do I resend the invitation email to a new user?
      - Can I email a user an invitation to join Workfront?
      instructions:
      - text: Send an invitation email to user {ID}.
        slots:
          ID: query.ID
      - text: Resend the invite to user {ID}.
        slots:
          ID: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/shouldShowProofHQNavButton'].put
  update:
    x-apievangelist-phrasing:
      intent: Check if the ProofHQ nav button shows
      effect: read
      questions:
      - Should the ProofHQ navigation button be shown to my user?
      - Can I check whether proofing navigation is visible?
      instructions:
      - text: Check if the ProofHQ nav button should show.
      - text: Tell me whether proofing navigation appears for me.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/userAdmins'].get
  update:
    x-apievangelist-phrasing:
      intent: List users who are user admins
      effect: read
      questions:
      - Which users have user-admin rights over others?
      - Can I filter the list of user admins?
      instructions:
      - text: List the user admins.
      - text: Show user admins matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'