Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MSSP Portal Account Groups API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/mssp/accountGroup'].get
$.paths['/mssp/accountGroup'].post
$.paths['/mssp/accountGroup/{account_group_uuid}'].get
$.paths['/mssp/accountGroup/{account_group_uuid}'].put
$.paths['/mssp/accountGroup/{account_group_uuid}'].delete

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 MSSP Portal Account Groups API
  version: 1.0.0
extends: openapi/tenable-account-groups-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: 5
- target: $.paths['/mssp/accountGroup'].get
  update:
    x-apievangelist-phrasing:
      intent: List MSSP account groups
      effect: read
      questions:
      - What account groups have I set up to organize my customer accounts?
      - Can a basic user see the list of account groups?
      instructions:
      - text: List all my MSSP account groups.
      - text: Show the account groups I use to organize customers.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mssp/accountGroup'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account group
      effect: write
      questions:
      - How do I group several customer accounts together?
      - Can I add child accounts to an account group when I create it?
      instructions:
      - text: Create account group {name}.
        slots:
          name: requestBody.name
      - text: Create account group {name} containing accounts {accountUuids}.
        slots:
          name: requestBody.name
          accountUuids: requestBody.accountUuids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mssp/accountGroup/{account_group_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account group's details
      effect: read
      questions:
      - Which customer accounts are in a specific account group?
      - Can I look up one account group by UUID?
      instructions:
      - text: Get the details of account group {account_group_uuid}.
        slots:
          account_group_uuid: path.account_group_uuid
      - text: Show the member accounts of account group {account_group_uuid}.
        slots:
          account_group_uuid: path.account_group_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mssp/accountGroup/{account_group_uuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account group
      effect: write
      questions:
      - Can I change which customer accounts belong to an account group?
      - Is it possible to rename an account group?
      instructions:
      - text: Rename account group {account_group_uuid} to {name}.
        slots:
          account_group_uuid: path.account_group_uuid
          name: requestBody.name
      - text: Set account group {account_group_uuid} named {name} to contain accounts {accountUuids}.
        slots:
          account_group_uuid: path.account_group_uuid
          name: requestBody.name
          accountUuids: requestBody.accountUuids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mssp/accountGroup/{account_group_uuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account group
      effect: destructive
      questions:
      - Can I delete an account group I no longer need?
      - Who is allowed to remove an account group in the MSSP Portal?
      instructions:
      - text: Delete account group {account_group_uuid}.
        slots:
          account_group_uuid: path.account_group_uuid
      - text: Remove account group {account_group_uuid} from the MSSP Portal.
        slots:
          account_group_uuid: path.account_group_uuid
      method: generated
      generated: '2026-10-01'