# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Admin User Profiles API
  version: 1.0.0
extends: openapi/optimizely-admin-user-profiles-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: 19
- target: $.paths['/api/v1/admin/AdminUserProfiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin console user profiles
      effect: read
      questions:
      - How do I list every admin user who can sign in to the Optimizely Commerce admin console?
      - Can I filter admin user profiles to just the deactivated ones?
      - Which admin users have not logged in recently?
      instructions:
      - text: List all admin user profiles.
      - text: List admin user profiles matching the filter {filter}, sorted by {orderby}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
      - text: Show the first {top} admin users in the console.
        slots:
          top: query.$top
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an admin console user
      effect: write
      questions:
      - How do I add a new administrator to the commerce admin console?
      - What details are required when creating an admin user profile?
      instructions:
      - text: Create an admin user {userName} for {firstName} {lastName} with email {email}.
        slots:
          userName: requestBody.userName
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          email: requestBody.email
      - text: Add a new admin console user {userName} whose console language is {defaultAdminConsoleLanguageCode}.
        slots:
          userName: requestBody.userName
          defaultAdminConsoleLanguageCode: requestBody.defaultAdminConsoleLanguageCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfiles({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one admin user profile
      effect: read
      questions:
      - How do I look up a single admin user's profile by its ID?
      - Can I see when a specific admin last logged in and whether they are deactivated?
      instructions:
      - text: Get admin user profile {id}.
        slots:
          id: path.id
      - text: Show the login and activation details for admin user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfiles({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an admin user profile
      effect: write
      questions:
      - How do I overwrite an entire admin user profile with a new record?
      - Is there a way to fully replace an admin user's details rather than patch a few fields?
      instructions:
      - text: Replace admin user profile {id} with a full record for email {email}.
        slots:
          id: path.id
          email: requestBody.email
      - text: Overwrite the whole profile of admin user {id}, setting position to {position}.
        slots:
          id: path.id
          position: requestBody.position
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfiles({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an admin user profile
      effect: destructive
      questions:
      - How do I permanently remove one admin user from the admin console?
      - Can I delete an admin profile only if it hasn't changed since I read it?
      instructions:
      - text: Delete admin user profile {id}.
        slots:
          id: path.id
      - text: Remove admin user {id} only if its ETag still matches {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfiles({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update fields on an admin user profile
      effect: write
      questions:
      - How do I change an admin user's phone number or email without resending everything?
      - Can I deactivate an admin user by updating their profile?
      instructions:
      - text: Update the email of admin user {id} to {email}.
        slots:
          id: path.id
          email: requestBody.email
      - text: Set isDeactivated to {isDeactivated} on admin user {id}.
        slots:
          id: path.id
          isDeactivated: requestBody.isDeactivated
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfiles/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank admin user profile template
      effect: read
      questions:
      - What default values does a new admin user profile start with?
      - Can I fetch an empty admin user template before creating one?
      instructions:
      - text: Fetch the default admin user profile template.
      - text: Show me the starting values for a new admin user.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfiles({id})/Default.Roles()'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the Roles function for an admin user
      effect: read
      questions:
      - How do I call the OData Roles function to see which roles an admin user holds?
      - Can I filter the result of the Roles function for one admin profile?
      instructions:
      - text: Call the Roles function for admin user profile {id}.
        slots:
          id: path.id
      - text: Run the Default.Roles() operation on admin user {id} filtered by {filter}.
        slots:
          id: path.id
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/AdminUserProfiles/Default.Current()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the signed-in admin via the Current function
      effect: read
      questions:
      - How do I find out which admin profile my API token belongs to using the Current function?
      - Can I call Default.Current() to get my own admin user record?
      instructions:
      - text: Call the Default.Current() function to get my admin profile.
      - text: Using the OData Current function, return only the fields {select} of my admin profile.
        slots:
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofiles/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the signed-in admin's own profile
      effect: read
      questions:
      - Who am I logged in as in the admin console, via the adminuserprofiles/current route?
      - Can I expand related data on my own admin profile from the current-user route?
      instructions:
      - text: Get my own admin profile from the adminuserprofiles/current route.
      - text: Fetch the current admin user and expand {expand}.
        slots:
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofiles({key})/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles assigned to an admin user
      effect: read
      questions:
      - Which roles are assigned to a given admin user through the roles route?
      - Can I page through an admin user's roles with top and skip?
      instructions:
      - text: List the roles assigned to admin user {key}.
        slots:
          key: path.key
      - text: Show the first {top} roles on admin user {key}.
        slots:
          key: path.key
          top: query.$top
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofiles({key})/roles'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an admin user's roles (PUT)
      effect: write
      questions:
      - How do I replace the full set of roles on an admin user with a PUT?
      - Can I overwrite an admin user's role assignments in one request?
      instructions:
      - text: Replace the roles on admin user {key} using PUT.
        slots:
          key: path.key
      - text: Overwrite every role assignment for admin {key} with PUT.
        slots:
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofiles({key})/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign roles to an admin user (POST)
      effect: write
      questions:
      - How do I post new role assignments to an admin user?
      - Can I grant roles to an admin through a POST to their roles route?
      instructions:
      - text: Assign roles to admin user {key} with a POST.
        slots:
          key: path.key
      - text: POST role assignments for admin {key}.
        slots:
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofiles({key})/roles'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove roles from an admin user
      effect: destructive
      questions:
      - How do I strip the roles from an admin user?
      - Can I revoke an admin user's role assignments without deleting the user?
      instructions:
      - text: Remove the roles from admin user {key}.
        slots:
          key: path.key
      - text: Revoke all role assignments for admin {key}, keeping the profile.
        slots:
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofiles/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete admin user profiles
      effect: destructive
      questions:
      - How do I delete several admin users at once?
      - Can I remove a batch of admin profiles by passing a list of IDs?
      instructions:
      - text: Bulk delete the admin user profiles with IDs {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these admin users in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofiles({key})/adminuserprofilepasswords({adminuserprofilepasswordKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a password record for an admin user
      effect: read
      questions:
      - How do I read one password history record stored for an admin user?
      - Can I see a specific admin user password entry by its key?
      instructions:
      - text: Get password record {adminuserprofilepasswordKey} for admin user {key}.
        slots:
          adminuserprofilepasswordKey: path.adminuserprofilepasswordKey
          key: path.key
      - text: Show admin {key}'s password entry {adminuserprofilepasswordKey}.
        slots:
          key: path.key
          adminuserprofilepasswordKey: path.adminuserprofilepasswordKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofiles({key})/adminuserprofilepreferences({adminuserprofilepreferenceKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a preference setting for an admin user
      effect: read
      questions:
      - How do I read one saved console preference for an admin user?
      - Can I fetch a single admin user preference by its key?
      instructions:
      - text: Get preference {adminuserprofilepreferenceKey} for admin user {key}.
        slots:
          adminuserprofilepreferenceKey: path.adminuserprofilepreferenceKey
          key: path.key
      - text: Show admin {key}'s console preference {adminuserprofilepreferenceKey}.
        slots:
          key: path.key
          adminuserprofilepreferenceKey: path.adminuserprofilepreferenceKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofiles({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an admin user
      effect: read
      questions:
      - How do I read a custom property stored on an admin user profile?
      - Can I fetch one extra property value from an admin user record?
      instructions:
      - text: Get custom property {custompropertyKey} on admin user {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the custom property {custompropertyKey} of admin profile {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/adminuserprofiles({key})/websites({websiteKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a website an admin user can manage
      effect: read
      questions:
      - How do I check whether an admin user is linked to a particular website?
      - Can I read one website assignment for an admin profile?
      instructions:
      - text: Get website {websiteKey} assigned to admin user {key}.
        slots:
          websiteKey: path.websiteKey
          key: path.key
      - text: Show the website {websiteKey} linked to admin profile {key}.
        slots:
          websiteKey: path.websiteKey
          key: path.key
      method: generated
      generated: '2026-09-26'