Drata · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SafeBase API documentation Account Members API

5 actions 5 updates phrasing extends openapi/drata-account-members-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Drata's API. It is a proposal applied on top of the contract, not a document Drata publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/accounts/members'].get
$.paths['/accounts/{id}/members'].post
$.paths['/accounts/{id}/members'].delete
$.paths['/accounts/{id}/members/notify'].post

OpenAPI Overlay

Raw ↑
# 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 Account Members API
  version: 1.0.0
extends: openapi/drata-account-members-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: 4
- target: $.paths['/accounts/members'].get
  update:
    x-apievangelist-phrasing:
      intent: Search account members
      effect: read
      questions:
      - Which accounts does a given member email belong to?
      - Can I search members by the account's Salesforce ID?
      instructions:
      - text: Find accounts that include member {email}.
        slots:
          email: query.email
      - text: Search members of the account with Salesforce ID {sfdcAccountId}.
        slots:
          sfdcAccountId: query.sfdcAccountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{id}/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Add members to an account
      effect: write
      questions:
      - How do I add people to a customer account?
      - Can I include a custom message when adding members?
      instructions:
      - text: Add members {members} to account {id}.
        slots:
          id: path.id
          members: requestBody.members
      - text: Add {members} to account {id} with the message {message}.
        slots:
          id: path.id
          members: requestBody.members
          message: requestBody.message
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{id}/members'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove members from an account
      effect: destructive
      questions:
      - How do I take someone off a customer account?
      - Can I remove several members from an account by email at once?
      instructions:
      - text: Remove members {members} from account {id}.
        slots:
          id: path.id
          members: requestBody.members
      - text: Delete the member emails {members} from account {id}.
        slots:
          id: path.id
          members: requestBody.members
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounts/{id}/members/notify'].post
  update:
    x-apievangelist-phrasing:
      intent: Email an invitation to account members
      effect: write
      questions:
      - What's the way to resend an invitation email to an account member?
      - Can I notify several members of an account in one request?
      instructions:
      - text: Send an invitation email to {email} for account {id}.
        slots:
          id: path.id
          email: requestBody.email
      - text: Notify members {email} of account {id} with message {message}.
        slots:
          id: path.id
          email: requestBody.email
          message: requestBody.message
      method: generated
      generated: '2026-09-26'