API Evangelist conversational phrasing for SafeBase API documentation Accounts API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for SafeBase API documentation Accounts API
  version: 1.0.0
extends: openapi/drata-accounts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: Find trust accounts
      effect: read
      questions:
      - How do I find a customer account by its company domain?
      - Can I filter accounts by review status?
      instructions:
      - text: Find accounts with domain {domain}.
        slots:
          domain: query.domain
      - text: List accounts named {name}.
        slots:
          name: query.name
      - text: Find the account linked to Salesforce ID {sfdcAccountId}.
        slots:
          sfdcAccountId: query.sfdcAccountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a trust account
      effect: write
      questions:
      - How do I add a new customer account to SafeBase?
      - What do I need to send to set up a new account?
      instructions:
      - text: Create an account from {input}.
        slots:
          input: requestBody.input
      - text: Add a new account with details {input}.
        slots:
          input: requestBody.input
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account by ID
      effect: read
      questions:
      - Where can I see one account's details by its ID?
      - What information is stored for a single account?
      instructions:
      - text: Get account {id}.
        slots:
          id: path.id
      - text: Show the details of account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account
      effect: destructive
      questions:
      - How do I delete an account we no longer need?
      - Can an account be removed by its ID?
      instructions:
      - text: Delete account {id}.
        slots:
          id: path.id
      - text: Remove account {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an existing account's access expiration
      effect: write
      questions:
      - Can I set an expiry date on an existing trust center account's access?
      - What happens if I give an existing account a past expiration date?
      - Is there a way to revoke an account's access without deleting the account?
      instructions:
      - text: Edit account {id} so its access expires on {accessExpiresAt}.
        slots:
          id: path.id
          accessExpiresAt: requestBody.accessExpiresAt
      - text: Revoke access for account {id} by setting its expiration to today.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{id}/url'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account's private page URL
      effect: read
      questions:
      - Where do I find an account's private trust page link?
      - Can I get the URL of the page a specific account sees?
      instructions:
      - text: Get the private page URL for account {id}.
        slots:
          id: path.id
      - text: Give me the link to account {id}'s private page.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'