API Evangelist conversational phrasing for Admin Portal - Admin Management Admin Account API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin Portal - Admin Management Admin Account API
  version: 1.0.0
extends: openapi/strivacity-admin-account-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: 21
- target: $.paths['/admin/api/v1/admin/identityStore/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin accounts
      effect: read
      questions:
      - Which Strivacity admin accounts have never logged in?
      - Can I filter admin accounts by role or by when they were disabled?
      - What admin accounts were created in the last month?
      instructions:
      - text: List all admin accounts that hold the role {roles}.
        slots:
          roles: query.roles
      - text: Find the admin account with login identifier {loginIdentifier}.
        slots:
          loginIdentifier: query.loginIdentifier
      - text: Show disabled admin accounts that have never logged in.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an admin account
      effect: write
      questions:
      - How do I add a new administrator to the admin portal?
      - Can I create an admin account without enforcing the password policy?
      instructions:
      - text: Create an admin account for {email}.
        slots:
          email: requestBody.email
      - text: Add an admin account for {email} with initial password {password}.
        slots:
          email: requestBody.email
          password: requestBody.password
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts/{accountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an admin account
      effect: read
      questions:
      - How can I look up the details of one specific admin account?
      - What does a single admin account record show?
      instructions:
      - text: Show me admin account {accountId}.
        slots:
          accountId: path.accountId
      - text: Fetch the details for admin account {accountId}.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts/{accountId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an admin account
      effect: destructive
      questions:
      - How do I permanently remove an administrator's account?
      - Can I delete the last remaining admin account?
      instructions:
      - text: Delete admin account {accountId}.
        slots:
          accountId: path.accountId
      - text: Permanently remove the administrator with account ID {accountId}.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts/{accountId}/authenticators'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an email or phone authenticator to an admin
      effect: write
      questions:
      - How do I register a phone number as an MFA authenticator for an admin?
      - Which authenticator types can be added to an admin account?
      instructions:
      - text: Add a {type} authenticator with target {target} to admin account {accountId}.
        slots:
          type: requestBody.type
          target: requestBody.target
          accountId: path.accountId
      - text: Register email {target} as an email authenticator for admin {accountId}.
        slots:
          target: requestBody.target
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts/{accountId}/authenticators/{authenticatorId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an authenticator from an admin account
      effect: destructive
      questions:
      - How do I remove an admin's old phone authenticator?
      - Can I delete a single MFA method from an administrator?
      instructions:
      - text: Delete authenticator {authenticatorId} from admin account {accountId}.
        slots:
          authenticatorId: path.authenticatorId
          accountId: path.accountId
      - text: Remove MFA method {authenticatorId} for admin {accountId}.
        slots:
          authenticatorId: path.authenticatorId
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts/{accountId}/disable'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable an admin account
      effect: write
      questions:
      - How do I suspend an administrator without deleting them?
      - Can I temporarily block an admin from signing in?
      instructions:
      - text: Disable admin account {accountId}.
        slots:
          accountId: path.accountId
      - text: Suspend sign-in for administrator {accountId}.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts/{accountId}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an admin account's data
      effect: read
      questions:
      - How do I export everything stored about an admin account?
      - Can I download an admin's account information as HTML or JSON?
      instructions:
      - text: Download admin account {accountId} information as {fileType}.
        slots:
          accountId: path.accountId
          fileType: query.fileType
      - text: Export a JSON file of admin {accountId}'s personal data.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts/{accountId}/enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-enable an admin account
      effect: write
      questions:
      - How do I reactivate a disabled administrator?
      - Can a suspended admin account be turned back on?
      instructions:
      - text: Enable admin account {accountId}.
        slots:
          accountId: path.accountId
      - text: Reactivate the disabled administrator {accountId}.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts/{accountId}/identities'].get
  update:
    x-apievangelist-phrasing:
      intent: List identities linked to an admin account
      effect: read
      questions:
      - Which identities are attached to an administrator's account?
      - How can I see the login identities an admin has?
      instructions:
      - text: List the identities for admin account {accountId}.
        slots:
          accountId: path.accountId
      - text: Show which login identities admin {accountId} has.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts/{accountId}/identities/identifier'].post
  update:
    x-apievangelist-phrasing:
      intent: Change an admin account's login identifier
      effect: write
      questions:
      - How do I change the email an admin uses to log in?
      - Can I update an administrator's login identifier?
      instructions:
      - text: Change admin {accountId}'s {type} identifier to {identifier}.
        slots:
          accountId: path.accountId
          type: requestBody.type
          identifier: requestBody.identifier
      - text: Update the login email of admin account {accountId} to {identifier}.
        slots:
          accountId: path.accountId
          identifier: requestBody.identifier
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts/{accountId}/liftPasscodeLock'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlock an admin locked out by passcode attempts
      effect: write
      questions:
      - An admin entered too many wrong one-time passcodes; how do I unlock them?
      - Can I clear a passcode lockout on an administrator?
      instructions:
      - text: Lift the passcode lock on admin account {accountId}.
        slots:
          accountId: path.accountId
      - text: Clear the OTP passcode lockout for admin {accountId}.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts/{accountId}/liftPasswordLock'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlock an admin locked out by password attempts
      effect: write
      questions:
      - How do I unlock an admin who was locked out after failed password attempts?
      - Can I remove a password lockout from an administrator?
      instructions:
      - text: Lift the password lock on admin account {accountId}.
        slots:
          accountId: path.accountId
      - text: Unlock admin {accountId} after too many wrong passwords.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts/{accountId}/notificationPreferences'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an admin's notification preferences
      effect: write
      questions:
      - How do I stop an admin getting emails when their MFA method changes?
      - Which security notifications can be toggled for an administrator?
      instructions:
      - text: Update notification preferences for admin {accountId} to turn off lockout alerts.
        slots:
          accountId: path.accountId
      - text: Set admin {accountId}'s password-reset-success notification to {passwordResetSuccess}.
        slots:
          accountId: path.accountId
          passwordResetSuccess: requestBody.passwordResetSuccess
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts/{accountId}/password/change'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a new password for an admin account
      effect: write
      questions:
      - How do I directly set a new password for an administrator?
      - Can I change an admin's password and bypass the password policy?
      instructions:
      - text: Change admin {accountId}'s password to {newPassword}.
        slots:
          accountId: path.accountId
          newPassword: requestBody.newPassword
      - text: Set password {newPassword} on admin account {accountId}, skipping the password policy.
        slots:
          newPassword: requestBody.newPassword
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts/{accountId}/password/reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an admin a password reset email
      effect: write
      questions:
      - How do I trigger a password reset email for an administrator?
      - Can I make an admin choose their own new password via a reset link?
      instructions:
      - text: Send a password reset email to admin {accountId}.
        slots:
          accountId: path.accountId
      - text: Request a forgotten-password reset for admin account {accountId}.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts/{accountId}/personal'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an admin account's profile metadata
      effect: write
      questions:
      - How do I edit profile attributes like name on an admin account?
      - Does updating admin metadata overwrite fields I don't send?
      instructions:
      - text: Update the profile metadata on admin account {accountId}.
        slots:
          accountId: path.accountId
      - text: Change the personal attributes stored for admin {accountId}.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts/{accountId}/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign roles to an admin account
      effect: write
      questions:
      - How do I give an administrator additional roles?
      - Can I assign several admin roles to one account at once?
      instructions:
      - text: Assign roles to admin account {accountId}.
        slots:
          accountId: path.accountId
      - text: Grant admin {accountId} the read-only and config roles.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts/{accountId}/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List an admin account's active sessions
      effect: read
      questions:
      - Which browsers is an administrator currently signed in on?
      - How can I see an admin's active sessions?
      instructions:
      - text: List the sessions for admin account {accountId}.
        slots:
          accountId: path.accountId
      - text: Show where admin {accountId} is logged in right now.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts/{accountId}/sessions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Log an admin out of every session
      effect: destructive
      questions:
      - How do I sign an administrator out of all browsers at once?
      - Can I force a back-channel logout for a compromised admin?
      instructions:
      - text: Clear all sessions for admin account {accountId}.
        slots:
          accountId: path.accountId
      - text: Log admin {accountId} out everywhere.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/identityStore/accounts/{accountId}/sessions/{sessionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: End one session for an admin account
      effect: destructive
      questions:
      - How do I revoke just one of an admin's sessions?
      - Can I kill a single suspicious admin login session?
      instructions:
      - text: Delete session {sessionId} for admin account {accountId}.
        slots:
          sessionId: path.sessionId
          accountId: path.accountId
      - text: End only session {sessionId} of admin {accountId}.
        slots:
          sessionId: path.sessionId
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'