Tenable · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for MSSP Portal Accounts API
7 actions
7 updates
phrasing
extends
openapi/tenable-accounts-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.
What the actions change
x-apievangelist-phrasing
Targets 7
$.info
$.paths['/mssp/accounts/eval'].post
$.paths['/mssp/accounts/v2/eval'].post
$.paths['/mssp/accounts/quote'].post
$.paths['/mssp/accounts'].get
$.paths['/mssp/accounts/{account_uuid}'].get
$.paths['/mssp/accounts/{account_uuid}/domains'].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 MSSP Portal Accounts API
version: 1.0.0
extends: openapi/tenable-accounts-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: 6
- target: $.paths['/mssp/accounts/eval'].post
update:
x-apievangelist-phrasing:
intent: Create an evaluation account (deprecated v1)
effect: write
questions:
- Can I still spin up a trial customer account with just an email and country using the old v1 endpoint?
- What does the deprecated v1 evaluation account call need?
instructions:
- text: Create a v1 evaluation account for {email} in country {country}.
slots:
email: requestBody.email
country: requestBody.country
- text: Use the legacy v1 eval endpoint to open a trial for {email}, country {country}.
slots:
email: requestBody.email
country: requestBody.country
method: generated
generated: '2026-10-01'
- target: $.paths['/mssp/accounts/v2/eval'].post
update:
x-apievangelist-phrasing:
intent: Create an evaluation account (v2)
effect: write
questions:
- How do I create a trial account for a new MSSP customer with specific licensed apps?
- Which apps can I license on a v2 evaluation account?
instructions:
- text: Create a v2 evaluation account for {customer_name} with apps {licensed_apps}, contact {default_contact_email}, country {country}.
slots:
customer_name: requestBody.customer_name
licensed_apps: requestBody.licensed_apps
default_contact_email: requestBody.default_contact_email
country: requestBody.country
- text: Open a v2 trial for {customer_name} in {country} licensing {licensed_apps}, contact {default_contact_email}, admin {admin_username}.
slots:
customer_name: requestBody.customer_name
country: requestBody.country
licensed_apps: requestBody.licensed_apps
default_contact_email: requestBody.default_contact_email
admin_username: requestBody.admin_username
method: generated
generated: '2026-10-01'
- target: $.paths['/mssp/accounts/quote'].post
update:
x-apievangelist-phrasing:
intent: Create a quote for a customer
effect: write
questions:
- Can I generate a quote for a new MSSP customer through the API?
- What partner, distributor and licensee details does a customer quote require?
instructions:
- text: Create a quote for {customer_name} with apps {licensed_apps} via partner {partner} and distributor {distributor}.
slots:
customer_name: requestBody.customer_name
licensed_apps: requestBody.licensed_apps
partner: requestBody.partner
distributor: requestBody.distributor
- text: Quote {customer_name} in region {region} for {licensed_apps}, admin {admin_username}, contact {contact}, requester {requester}, licensee {licensee}.
slots:
customer_name: requestBody.customer_name
region: requestBody.region
licensed_apps: requestBody.licensed_apps
admin_username: requestBody.admin_username
contact: requestBody.contact
requester: requestBody.requester
licensee: requestBody.licensee
method: generated
generated: '2026-10-01'
- target: $.paths['/mssp/accounts'].get
update:
x-apievangelist-phrasing:
intent: List MSSP child accounts
effect: read
questions:
- Which customer child accounts do I manage in the MSSP Portal?
- Can I list only the child accounts in one account group?
instructions:
- text: List all my MSSP child accounts.
- text: List child accounts in account group {group}.
slots:
group: query.group
method: generated
generated: '2026-10-01'
- target: $.paths['/mssp/accounts/{account_uuid}'].get
update:
x-apievangelist-phrasing:
intent: Get a child account's details
effect: read
questions:
- What license information does a specific customer child account have?
- Can I look up one child account by UUID?
instructions:
- text: Get the details of child account {account_uuid}.
slots:
account_uuid: path.account_uuid
- text: Show the licensing for customer account {account_uuid}.
slots:
account_uuid: path.account_uuid
method: generated
generated: '2026-10-01'
- target: $.paths['/mssp/accounts/{account_uuid}/domains'].get
update:
x-apievangelist-phrasing:
intent: List domains of a child account
effect: read
questions:
- Which domains are registered to a given customer child account?
- What domains does this MSSP customer use?
instructions:
- text: List the domains for child account {account_uuid}.
slots:
account_uuid: path.account_uuid
- text: Show the domains registered on customer account {account_uuid}.
slots:
account_uuid: path.account_uuid
method: generated
generated: '2026-10-01'