Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tenable Platform & Settings Permissions API

3 actions 3 updates phrasing extends openapi/tenable-permissions-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 3

$.info
$.paths['/permissions/{object_type}/{object_id}'].get
$.paths['/permissions/{object_type}/{object_id}'].put

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 Tenable Platform & Settings Permissions API
  version: 1.0.0
extends: openapi/tenable-permissions-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: 2
- target: $.paths['/permissions/{object_type}/{object_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an object's permissions
      effect: read
      questions:
      - Who can use a particular scanner or agent group?
      - What access controls are set on a scanner pool?
      instructions:
      - text: Show the permissions on {object_type} {object_id}.
        slots:
          object_type: path.object_type
          object_id: path.object_id
      - text: List who has access to {object_type} object {object_id}.
        slots:
          object_type: path.object_type
          object_id: path.object_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/permissions/{object_type}/{object_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an object's permissions
      effect: write
      questions:
      - How do I grant a user access to a specific scanner?
      - Can I replace the access control list on an agent group?
      instructions:
      - text: Set the access list of {object_type} {object_id} to {acls}.
        slots:
          object_type: path.object_type
          object_id: path.object_id
          acls: requestBody.acls
      - text: Update permissions on {object_type} {object_id}.
        slots:
          object_type: path.object_type
          object_id: path.object_id
      method: generated
      generated: '2026-10-01'