API Evangelist conversational phrasing for Account Management Tenants API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Account Management Tenants API
  version: 1.0.0
extends: openapi/acronis-tenants-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: 36
- target: $.paths['/tenants'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several tenants or a tenant's children
      effect: read
      questions:
      - How do I pull details for a list of tenants by their UUIDs in one call?
      - Can I get every child tenant under a parent tenant, including deleted ones?
      - Which tenants changed since a given date across my Acronis hierarchy?
      instructions:
      - text: Fetch the tenants with UUIDs {uuids}.
        slots:
          uuids: query.uuids
      - text: List the child tenants of parent tenant {parent_id}.
        slots:
          parent_id: query.parent_id
      - text: Show tenants in the subtree under {subtree_root_id} updated since {updated_since}.
        slots:
          subtree_root_id: query.subtree_root_id
          updated_since: query.updated_since
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new tenant
      effect: write
      questions:
      - How do I create a new customer tenant under my partner account?
      - What kinds of tenant can I create, and do I need a parent tenant?
      - Can I set an external customer ID on a tenant when I create it?
      instructions:
      - text: Create a {kind} tenant named {name} under parent tenant {parent_id}.
        slots:
          kind: requestBody.kind
          name: requestBody.name
          parent_id: requestBody.parent_id
      - text: Create a new tenant {name} of kind {kind} under {parent_id} with external customer ID {customer_id}.
        slots:
          name: requestBody.name
          kind: requestBody.kind
          parent_id: requestBody.parent_id
          customer_id: requestBody.customer_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List application IDs for several tenants
      effect: read
      questions:
      - Which applications are enabled for each of these tenants at once?
      - Can I get the application UUIDs for a batch of tenants in a single request?
      instructions:
      - text: Get the application UUIDs for tenants {tenants}.
        slots:
          tenants: query.tenants
      - text: Show which applications each of tenants {tenants} has.
        slots:
          tenants: query.tenants
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/offering_items'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch offering items across a tenant tree
      effect: read
      questions:
      - How can I see offering items and quotas for every tenant below a given tenant?
      - Can I filter offering items across a tenant subtree by edition or usage name?
      - Which offering items across my tenant tree were updated since last week?
      instructions:
      - text: List offering items and quotas for all tenants under {subtree_root_tenant_id}.
        slots:
          subtree_root_tenant_id: query.subtree_root_tenant_id
      - text: Fetch offering items in edition {editions} across the tenant tree rooted at {subtree_root_tenant_id}.
        slots:
          editions: query.editions
          subtree_root_tenant_id: query.subtree_root_tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/usages'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch usage metrics for several tenants
      effect: read
      questions:
      - Can I get usage figures for a batch of tenants at the same time?
      - What usage has each of my customer tenants consumed, filtered by usage name?
      instructions:
      - text: Get usages for tenants {tenants}.
        slots:
          tenants: query.tenants
      - text: Fetch the {usage_names} usage for tenants {tenants}.
        slots:
          usage_names: query.usage_names
          tenants: query.tenants
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/usages'].put
  update:
    x-apievangelist-phrasing:
      intent: Report usage values for tenants
      effect: write
      questions:
      - How do I report usage values for my tenants from an external integration?
      - Can usage be reported per resource rather than per tenant?
      instructions:
      - text: 'Report these usage values for my tenants: {items}.'
        slots:
          items: requestBody.items
      - text: Push updated usage counters {items} for the offering items.
        slots:
          items: requestBody.items
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tenant's details
      effect: read
      questions:
      - How do I look up a single tenant by its ID?
      - Can I see a tenant's full path in the hierarchy when I fetch it?
      instructions:
      - text: Show me tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Fetch tenant {tenant_id} with its path embedded, even if it was deleted.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a tenant's properties
      effect: write
      questions:
      - How do I rename a tenant or disable it?
      - Can I change a tenant's preferred language or external customer ID?
      - Why does updating a tenant require its current version number?
      instructions:
      - text: Rename tenant {tenant_id} to {name} using version {version}.
        slots:
          tenant_id: path.tenant_id
          name: requestBody.name
          version: requestBody.version
      - text: Disable tenant {tenant_id} (version {version}) by setting enabled to {enabled}.
        slots:
          tenant_id: path.tenant_id
          version: requestBody.version
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tenant
      effect: destructive
      questions:
      - How do I delete a customer tenant I no longer need?
      - Can a deleted tenant be brought back later?
      instructions:
      - text: Delete tenant {tenant_id} at version {version}.
        slots:
          tenant_id: path.tenant_id
          version: query.version
      - text: Remove tenant {tenant_id} from the hierarchy.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/offering_items'].get
  update:
    x-apievangelist-phrasing:
      intent: List a tenant's offering items and quotas
      effect: read
      questions:
      - What services and quotas are turned on for this one tenant?
      - Can I see only the active offering items for a tenant in a given edition?
      instructions:
      - text: List the offering items and quotas for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Show active offering items of edition {edition} for tenant {tenant_id}.
        slots:
          edition: query.edition
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/offering_items'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a tenant's offering items and quotas
      effect: write
      questions:
      - How do I turn on a service and set its quota for a customer tenant?
      - Can I check whether an offering item is still in use before switching it off?
      instructions:
      - text: Set offering items {offering_items} for tenant {tenant_id}.
        slots:
          offering_items: requestBody.offering_items
          tenant_id: path.tenant_id
      - text: Update quotas on tenant {tenant_id} to {offering_items}, checking usage first.
        slots:
          tenant_id: path.tenant_id
          offering_items: requestBody.offering_items
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/offering_items/available_for_child'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview offering items for a new child tenant
      effect: read
      questions:
      - Which offering items would a new child tenant under this tenant be able to get?
      - What services are available to a customer-kind child of my partner tenant?
      instructions:
      - text: Show offering items available for a child of tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: List what a {kind} child tenant under {tenant_id} could be given.
        slots:
          kind: query.kind
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/offering_items/pricing'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tenant's offering item prices
      effect: read
      questions:
      - What prices are set on the offering items for this tenant?
      - Can I see per-item pricing a partner charges a customer tenant?
      instructions:
      - text: Show offering item prices for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Get the price list of tenant {tenant_id}'s offering items.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/offering_items/pricing'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a tenant's offering item prices
      effect: write
      questions:
      - How do I change what a tenant is charged for each offering item?
      - Can I update several offering item prices for a tenant at once?
      instructions:
      - text: Set offering item prices for tenant {tenant_id} to {items}.
        slots:
          tenant_id: path.tenant_id
          items: requestBody.items
      - text: Update tenant {tenant_id}'s item pricing with {items}.
        slots:
          tenant_id: path.tenant_id
          items: requestBody.items
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/edition'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a tenant can switch edition
      effect: read
      questions:
      - Before switching editions, can I check whether a tenant is able to move to the target one?
      - What would block a tenant from changing to another edition of an application?
      instructions:
      - text: Check whether tenant {tenant_id} can switch application {application_id} to edition {target_edition}.
        slots:
          tenant_id: path.tenant_id
          application_id: query.application_id
          target_edition: query.target_edition
      - text: Run an edition switch check for {tenant_id} to {target_edition} on {application_id}.
        slots:
          tenant_id: path.tenant_id
          target_edition: query.target_edition
          application_id: query.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/edition'].put
  update:
    x-apievangelist-phrasing:
      intent: Switch a tenant to another edition
      effect: write
      questions:
      - How do I move a customer tenant to a different edition?
      - Can I change the edition for just one application on a tenant?
      instructions:
      - text: Switch tenant {tenant_id} to edition {target_edition} for application {application_id}.
        slots:
          tenant_id: path.tenant_id
          target_edition: requestBody.target_edition
          application_id: requestBody.application_id
      - text: Move {tenant_id} onto the {target_edition} edition of {application_id} now.
        slots:
          tenant_id: path.tenant_id
          target_edition: requestBody.target_edition
          application_id: requestBody.application_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/registration_tokens'].get
  update:
    x-apievangelist-phrasing:
      intent: List a tenant's registration tokens
      effect: read
      questions:
      - Which agent registration tokens exist for this tenant?
      - Can I see the registration tokens issued under a specific tenant?
      instructions:
      - text: List registration tokens for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Show the tokens tenant {tenant_id} can use to register agents.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/registration_tokens'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a registration token for a tenant
      effect: write
      questions:
      - How do I generate a token so machines can register agents under a tenant?
      - What is the longest expiry a tenant registration token can have?
      instructions:
      - text: Create a registration token for tenant {tenant_id} expiring in {expires_in} seconds with scopes {scopes}.
        slots:
          tenant_id: path.tenant_id
          expires_in: requestBody.expires_in
          scopes: requestBody.scopes
      - text: Issue tenant {tenant_id} an agent registration token scoped to {scopes}, valid {expires_in} seconds.
        slots:
          tenant_id: path.tenant_id
          scopes: requestBody.scopes
          expires_in: requestBody.expires_in
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List applications available to a tenant
      effect: read
      questions:
      - What applications can this tenant use?
      - Can I get a tenant's available applications formatted for a UI?
      instructions:
      - text: List applications available to tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Show which applications tenant {tenant_id} has access to.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List a tenant's users
      effect: read
      questions:
      - How do I get all the users that belong to a tenant?
      - Can I include hidden or deleted users when listing a tenant's users?
      instructions:
      - text: List the user UUIDs in tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Get users of tenant {tenant_id} ordered by {order}.
        slots:
          tenant_id: path.tenant_id
          order: query.order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/children'].get
  update:
    x-apievangelist-phrasing:
      intent: List a tenant's direct children
      effect: read
      questions:
      - What child tenants sit directly under this tenant?
      - Can I page through the child tenant UUIDs of one tenant, sorted by name?
      instructions:
      - text: List the child tenant UUIDs of tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Show children of {tenant_id} ordered by {order}.
        slots:
          tenant_id: path.tenant_id
          order: query.order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List reports available to a tenant
      effect: read
      questions:
      - Which reports can this tenant access?
      - Can I get the report IDs configured for a tenant?
      instructions:
      - text: List the reports available to tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Get report UUIDs for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List infrastructure locations a tenant owns
      effect: read
      questions:
      - Which infrastructure locations does this tenant own?
      - Can I see the data center locations registered to a tenant?
      instructions:
      - text: List infrastructure locations owned by tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Show tenant {tenant_id}'s locations.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/usages'].get
  update:
    x-apievangelist-phrasing:
      intent: Get usage metrics for one tenant
      effect: read
      questions:
      - How much storage and how many workloads has this one tenant used?
      - Can I filter a single tenant's usage by edition?
      instructions:
      - text: Show usage metrics for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Get tenant {tenant_id}'s {usage_names} usage.
        slots:
          tenant_id: path.tenant_id
          usage_names: query.usage_names
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/pricing'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tenant's pricing settings
      effect: read
      questions:
      - What pricing mode and currency is this tenant set up with?
      - Can I check whether a tenant is on trial or production pricing?
      instructions:
      - text: Show pricing settings for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Get the pricing mode and currency of tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/pricing'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a tenant's pricing mode or currency
      effect: write
      questions:
      - How do I change the pricing mode for a tenant?
      - Can I set the currency used for a tenant's offering item prices?
      instructions:
      - text: Set tenant {tenant_id}'s pricing mode to {mode} (version {version}).
        slots:
          tenant_id: path.tenant_id
          mode: requestBody.mode
          version: requestBody.version
      - text: Change the pricing currency of {tenant_id} to {currency} at version {version}.
        slots:
          tenant_id: path.tenant_id
          currency: requestBody.currency
          version: requestBody.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/brand'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tenant's branding options
      effect: read
      questions:
      - What white-label branding is configured for this tenant?
      - Can I see the brand a tenant inherits from its parent?
      instructions:
      - text: Show the branding options for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Get the effective inherited brand for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/brand'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a tenant's custom branding
      effect: write
      questions:
      - How do I change the support URL and company name shown to my customers?
      - Can I override the SMTP server used for branded emails?
      - What branding fields can I customize, like colors and app download links?
      instructions:
      - text: Set tenant {tenant_id}'s brand company name to {company_name} (version {version}).
        slots:
          tenant_id: path.tenant_id
          company_name: requestBody.company_name
          version: query.version
      - text: Update the support URL for tenant {tenant_id}'s brand to {support_url}.
        slots:
          tenant_id: path.tenant_id
          support_url: requestBody.support_url
      - text: Point tenant {tenant_id}'s branded email at SMTP server {smtp_server} port {smtp_port}.
        slots:
          tenant_id: path.tenant_id
          smtp_server: requestBody.smtp_server
          smtp_port: requestBody.smtp_port
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/brand'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn on custom branding for a tenant
      effect: write
      questions:
      - How do I enable white-label branding for my partner tenant?
      - Why can't custom branding be enabled on a customer or unit tenant?
      instructions:
      - text: Enable custom branding for tenant {tenant_id} at version {version}.
        slots:
          tenant_id: path.tenant_id
          version: query.version
      - text: Switch on white-labeling for {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/brand'].delete
  update:
    x-apievangelist-phrasing:
      intent: Turn off custom branding for a tenant
      effect: destructive
      questions:
      - How do I remove white-label branding from a tenant?
      - Can I revert a tenant to default branding?
      instructions:
      - text: Disable custom branding for tenant {tenant_id} at version {version}.
        slots:
          tenant_id: path.tenant_id
          version: query.version
      - text: Turn off white-labeling on {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/brand/logo'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a tenant's brand logo
      effect: read
      questions:
      - Can I download the logo a tenant uses in its branding?
      - Where do I get the current brand logo image for a tenant?
      instructions:
      - text: Download the brand logo of tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Fetch {tenant_id}'s logo image.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/brand/logo'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a new brand logo for a tenant
      effect: write
      questions:
      - How do I upload my company logo for white-labeled branding?
      - Can I replace a tenant's brand logo with a new image?
      instructions:
      - text: Upload a new logo for tenant {tenant_id} at version {version}.
        slots:
          tenant_id: path.tenant_id
          version: query.version
      - text: Replace {tenant_id}'s brand logo with this image of {Content-Length} bytes.
        slots:
          tenant_id: path.tenant_id
          Content-Length: header.Content-Length
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/mfa/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a tenant's MFA status
      effect: read
      questions:
      - Is two-factor authentication turned on for this tenant?
      - How many users in a tenant have finished setting up TOTP?
      instructions:
      - text: Show MFA status for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Check TOTP enrollment progress for users in {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/mfa/status'].put
  update:
    x-apievangelist-phrasing:
      intent: Turn MFA on or off for a tenant
      effect: write
      questions:
      - How do I enforce multi-factor authentication for a whole tenant?
      - Can MFA be toggled on folder or unit tenants?
      instructions:
      - text: Set MFA for tenant {tenant_id} to {enabled}.
        slots:
          tenant_id: path.tenant_id
          enabled: requestBody.enabled
      - text: Enable two-factor authentication for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/default_idp'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a tenant's default identity provider
      effect: write
      questions:
      - How do I change which identity provider a tenant signs in with by default?
      - Can a new default identity provider be applied to child tenants too?
      instructions:
      - text: 'Set identity provider {idp_id} as default for tenant {tenant_id} (version {version}), applying to children: {apply_to_children}.'
        slots:
          idp_id: requestBody.idp_id
          tenant_id: path.tenant_id
          version: requestBody.version
          apply_to_children: requestBody.apply_to_children
      - text: Make {idp_id} the default IdP of {tenant_id}.
        slots:
          idp_id: requestBody.idp_id
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a soft-deleted tenant
      effect: write
      questions:
      - Can I undo the deletion of a tenant?
      - What happens if restoring a deleted tenant runs into a conflict?
      instructions:
      - text: Restore deleted tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Force-restore tenant {tenant_id} even if there is a conflict.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'