Acronis · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Acronis Users API
16 actions
16 updates
phrasing
extends
openapi/acronis-users-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Acronis's API. It is a proposal applied on top of the contract, not a document Acronis publishes.
What the actions change
x-apievangelist-phrasing
Targets 16
$.info
$.paths['/users'].get
$.paths['/users'].post
$.paths['/users/check_login'].get
$.paths['/users/check_password'].post
$.paths['/users/me'].get
$.paths['/users/{user_id}'].get
$.paths['/users/{user_id}'].put
$.paths['/users/{user_id}'].delete
$.paths['/users/{user_id}/access_policies'].get
$.paths['/users/{user_id}/access_policies'].put
$.paths['/users/{user_id}/mfa/status'].put
$.paths['/users/{user_id}/password'].post
$.paths['/users/{user_id}/send-activation-email'].post
$.paths['/users/{user_id}/restore'].post
$.paths['/users/{user_uuid}'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Acronis Users API
version: 1.0.0
extends: openapi/acronis-users-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: 15
- target: $.paths['/users'].get
update:
x-apievangelist-phrasing:
intent: List users in a tenant
effect: read
questions:
- How do I list all users that belong to a tenant?
- Can I get only users updated since a certain date?
- Which users in a tenant subtree have a given access policy?
instructions:
- text: List users in tenant {tenant_id}.
slots:
tenant_id: query.tenant_id
- text: List users under tenant {subtree_root_tenant_id} updated since {updated_since}.
slots:
subtree_root_tenant_id: query.subtree_root_tenant_id
updated_since: query.updated_since
- text: Fetch users with IDs {uuids}.
slots:
uuids: query.uuids
method: generated
generated: '2026-09-26'
- target: $.paths['/users'].post
update:
x-apievangelist-phrasing:
intent: Create a user account
effect: write
questions:
- How do I add a new user to a customer tenant?
- Does creating a user in a customer tenant also create a personal tenant?
- Can I set a user to be disabled automatically after a date?
instructions:
- text: Create user {login} in tenant {tenant_id}.
slots:
login: requestBody.login
tenant_id: requestBody.tenant_id
- text: Add user {login} to tenant {tenant_id} with contact {contact}.
slots:
login: requestBody.login
tenant_id: requestBody.tenant_id
contact: requestBody.contact
method: generated
generated: '2026-09-26'
- target: $.paths['/users/check_login'].get
update:
x-apievangelist-phrasing:
intent: Check if a username is taken
effect: read
questions:
- Is a particular login name still available?
- How can I check a username before creating the account?
instructions:
- text: Check whether username {username} is available.
slots:
username: query.username
- text: See if login {username} is already taken.
slots:
username: query.username
method: generated
generated: '2026-09-26'
- target: $.paths['/users/check_password'].post
update:
x-apievangelist-phrasing:
intent: Check a password against breach data
effect: read
questions:
- Has a password appeared in a known data breach?
- Can I screen a new password for leaks before setting it?
instructions:
- text: Check whether password {password} has been exposed in a breach.
slots:
password: requestBody.password
- text: Screen {password} against breached-password lists.
slots:
password: requestBody.password
method: generated
generated: '2026-09-26'
- target: $.paths['/users/me'].get
update:
x-apievangelist-phrasing:
intent: Get the signed-in user's profile
effect: read
questions:
- Who am I authenticated as right now?
- How do I get the profile of the currently logged-in user?
instructions:
- text: Show my own user profile.
- text: Get details of the currently authenticated account.
method: generated
generated: '2026-09-26'
- target: $.paths['/users/{user_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a user by ID
effect: read
questions:
- How do I look up a single user account by its ID?
- Can I retrieve a user that has been soft-deleted?
instructions:
- text: Show user {user_id}.
slots:
user_id: path.user_id
- text: Get user {user_id} even if they were deleted.
slots:
user_id: path.user_id
method: generated
generated: '2026-09-26'
- target: $.paths['/users/{user_id}'].put
update:
x-apievangelist-phrasing:
intent: Update a user account
effect: write
questions:
- How do I change a user's contact info or language?
- Can I disable a user account without deleting it?
- Why does updating a user require a version number?
instructions:
- text: Update user {user_id} at version {version} with contact {contact}.
slots:
user_id: path.user_id
version: requestBody.version
contact: requestBody.contact
- text: Set enabled to {enabled} for user {user_id}, version {version}.
slots:
enabled: requestBody.enabled
user_id: path.user_id
version: requestBody.version
method: generated
generated: '2026-09-26'
- target: $.paths['/users/{user_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a user account
effect: destructive
questions:
- How do I delete a user account?
- What version value is needed to delete a user?
instructions:
- text: Delete user {user_id} at version {version}.
slots:
user_id: path.user_id
version: query.version
- text: Remove account {user_id}, version {version}.
slots:
user_id: path.user_id
version: query.version
method: generated
generated: '2026-09-26'
- target: $.paths['/users/{user_id}/access_policies'].get
update:
x-apievangelist-phrasing:
intent: List a user's access policies
effect: read
questions:
- What roles and access policies does a user have?
- Can I include policies a user inherits from their groups?
instructions:
- text: List access policies for user {user_id}.
slots:
user_id: path.user_id
- text: Show user {user_id}'s policies including group ones.
slots:
user_id: path.user_id
method: generated
generated: '2026-09-26'
- target: $.paths['/users/{user_id}/access_policies'].put
update:
x-apievangelist-phrasing:
intent: Replace a user's access policies
effect: write
questions:
- How do I change which roles a user has?
- Does updating access policies add to them or overwrite the existing set?
instructions:
- text: Replace user {user_id}'s access policies with {items}, timestamp {timestamp}.
slots:
user_id: path.user_id
items: requestBody.items
timestamp: requestBody.timestamp
- text: Rewrite the roles of user {user_id} to {items} as of {timestamp}.
slots:
user_id: path.user_id
items: requestBody.items
timestamp: requestBody.timestamp
method: generated
generated: '2026-09-26'
- target: $.paths['/users/{user_id}/mfa/status'].put
update:
x-apievangelist-phrasing:
intent: Turn MFA on or off for a user
effect: write
questions:
- How do I enforce multi-factor authentication for one user?
- Can I disable MFA for a user who lost their device?
instructions:
- text: Set MFA enabled to {enabled} for user {user_id}.
slots:
enabled: requestBody.enabled
user_id: path.user_id
- text: Turn two-factor authentication {enabled} for {user_id}.
slots:
enabled: requestBody.enabled
user_id: path.user_id
method: generated
generated: '2026-09-26'
- target: $.paths['/users/{user_id}/password'].post
update:
x-apievangelist-phrasing:
intent: Set a user's password
effect: write
questions:
- How do I set a password for a user from an OAuth client?
- Who is allowed to set a user's password through the API?
instructions:
- text: Set the password of user {user_id} to {password}.
slots:
user_id: path.user_id
password: requestBody.password
- text: Assign password {password} to account {user_id}.
slots:
password: requestBody.password
user_id: path.user_id
method: generated
generated: '2026-09-26'
- target: $.paths['/users/{user_id}/send-activation-email'].post
update:
x-apievangelist-phrasing:
intent: Send a user their activation email
effect: write
questions:
- How do I resend the activation email to a new user?
- Can I trigger an account activation email through the API?
instructions:
- text: Send the activation email to user {user_id}.
slots:
user_id: path.user_id
- text: Resend account activation to {user_id}.
slots:
user_id: path.user_id
method: generated
generated: '2026-09-26'
- target: $.paths['/users/{user_id}/restore'].post
update:
x-apievangelist-phrasing:
intent: Restore a deleted user
effect: write
questions:
- Can I bring back a user that was deleted?
- Is it possible to restore a user and enable them at the same time?
instructions:
- text: Restore deleted user {user_id}.
slots:
user_id: path.user_id
- text: Undelete user {user_id} and set enabled to {enable}.
slots:
user_id: path.user_id
enable: query.enable
method: generated
generated: '2026-09-26'
- target: $.paths['/users/{user_uuid}'].get
update:
x-apievangelist-phrasing:
intent: Get a Sync & Share user by UUID
effect: read
questions:
- How do I look up a Sync & Share user by their UUID?
- Can I get a user's details scoped to a particular tenant in Sync & Share?
instructions:
- text: Show Sync & Share user {user_uuid}.
slots:
user_uuid: path.user_uuid
- text: Get Sync & Share user {user_uuid} in tenant {tenant_id}.
slots:
user_uuid: path.user_uuid
tenant_id: query.tenant_id
method: generated
generated: '2026-09-26'