Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tenable Platform & Settings Access Groups v2 API

8 actions 8 updates phrasing extends openapi/tenable-access-groups-v2-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 8

$.info

$.paths['/v2/access-groups'].get

$.paths['/v2/access-groups'].post

$.paths['/v2/access-groups/{id}'].get

$.paths['/v2/access-groups/{id}'].put

$.paths['/v2/access-groups/{id}'].delete

$.paths['/v2/access-groups/filters'].get

$.paths['/v2/access-groups/rules/filters'].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 Tenable Platform & Settings Access Groups v2 API
  version: 1.0.0
extends: openapi/tenable-access-groups-v2-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: 7
- target: $.paths['/v2/access-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List access groups (deprecated)
      effect: read
      questions:
      - Which legacy access groups are still defined in my account?
      - Can I filter access groups by name or type?
      - Are access groups deprecated in favour of access control?
      instructions:
      - text: List my access groups.
      - text: List access groups where {f}, up to {limit}.
        slots:
          f: query.f
          limit: query.limit
      - text: Search access groups for {w} in fields {wf}.
        slots:
          w: query.w
          wf: query.wf
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/access-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an access group (deprecated)
      effect: write
      questions:
      - How do I create an access group that limits which assets users can see?
      - Can a new access group include all users or all assets?
      instructions:
      - text: Create an access group named {name} with asset rules {rules}.
        slots:
          name: requestBody.name
          rules: requestBody.rules
      - text: Create access group {name} for principals {principals}.
        slots:
          name: requestBody.name
          principals: requestBody.principals
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/access-groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an access group's details
      effect: read
      questions:
      - What rules and principals are in a particular access group?
      - Where do I look up one access group's settings?
      instructions:
      - text: Get details for access group {id}.
        slots:
          id: path.id
      - text: Show the rules and principals of access group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/access-groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an access group (deprecated)
      effect: write
      questions:
      - Does updating an access group overwrite its existing rules?
      - Can I change which users belong to an access group?
      instructions:
      - text: Replace the rules of access group {id} with {rules}.
        slots:
          id: path.id
          rules: requestBody.rules
      - text: Rename access group {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set the principals on access group {id} to {principals}.
        slots:
          id: path.id
          principals: requestBody.principals
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/access-groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an access group
      effect: destructive
      questions:
      - How do I delete an old access group?
      - Can I remove a deprecated access group after moving to access control?
      instructions:
      - text: Delete access group {id}.
        slots:
          id: path.id
      - text: Remove the legacy access group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/access-groups/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List filters for access groups
      effect: read
      questions:
      - Which filters can I use when listing access groups?
      - What fields are filterable on the access group list?
      instructions:
      - text: List the filters available for access groups.
      - text: Show which fields I can filter access groups on.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/access-groups/rules/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List filters for access group asset rules
      effect: read
      questions:
      - What asset attributes can an access group rule match on?
      - Which filters are available when defining asset rules?
      instructions:
      - text: List the asset rule filters for access groups.
      - text: Show the attributes I can use in access group asset rules.
      method: generated
      generated: '2026-10-01'