Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Tenable Platform & Settings Access Control (Groups) API

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

$.info

$.paths['/groups'].get

$.paths['/groups'].post

$.paths['/groups/{group_uuid}'].put

$.paths['/groups/{group_uuid}'].delete

$.paths['/groups/{group_uuid}/users'].get

$.paths['/groups/{group_uuid}/users/{user_uuid}'].post

$.paths['/groups/{group_uuid}/users/{user_uuid}'].delete

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 Control (Groups) API
  version: 1.0.0
extends: openapi/tenable-access-control-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: 7
- target: $.paths['/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List user groups
      effect: read
      questions:
      - What user groups exist in my Tenable container?
      - Where can I see all the groups users can belong to?
      instructions:
      - text: List all user groups.
      - text: Show every user group in my container.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user group
      effect: write
      questions:
      - How do I create a new user group?
      - Can a user group be managed through SAML?
      instructions:
      - text: Create a user group named {name}.
        slots:
          name: requestBody.name
      - text: Create group {name} with SAML management set to {managed_by_saml}.
        slots:
          name: requestBody.name
          managed_by_saml: requestBody.managed_by_saml
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group_uuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or update a user group
      effect: write
      questions:
      - Can I rename an existing user group?
      - Is it possible to switch a group to SAML-managed after creating it?
      instructions:
      - text: Rename user group {group_uuid} to {name}.
        slots:
          group_uuid: path.group_uuid
          name: requestBody.name
      - text: Update group {group_uuid} to name {name} and SAML-managed {managed_by_saml}.
        slots:
          group_uuid: path.group_uuid
          name: requestBody.name
          managed_by_saml: requestBody.managed_by_saml
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group_uuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user group
      effect: destructive
      questions:
      - Why can't I delete a user group that still has members?
      - What's required to delete a user group?
      instructions:
      - text: Delete user group {group_uuid}.
        slots:
          group_uuid: path.group_uuid
      - text: Remove the empty group {group_uuid}.
        slots:
          group_uuid: path.group_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group_uuid}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users in a group
      effect: read
      questions:
      - Who are the members of a particular user group?
      - Which users belong to a group?
      instructions:
      - text: List the users in group {group_uuid}.
        slots:
          group_uuid: path.group_uuid
      - text: Show members of user group {group_uuid}.
        slots:
          group_uuid: path.group_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group_uuid}/users/{user_uuid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user to a group
      effect: write
      questions:
      - How do I add someone to a user group?
      - Can an administrator put a user into a group via the API?
      instructions:
      - text: Add user {user_uuid} to group {group_uuid}.
        slots:
          user_uuid: path.user_uuid
          group_uuid: path.group_uuid
      - text: Put user {user_uuid} in user group {group_uuid}.
        slots:
          user_uuid: path.user_uuid
          group_uuid: path.group_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group_uuid}/users/{user_uuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from a group
      effect: destructive
      questions:
      - How do I take a user out of a group without deleting the user?
      - Can I remove a member from a user group?
      instructions:
      - text: Remove user {user_uuid} from group {group_uuid}.
        slots:
          user_uuid: path.user_uuid
          group_uuid: path.group_uuid
      - text: Take {user_uuid} out of user group {group_uuid}.
        slots:
          user_uuid: path.user_uuid
          group_uuid: path.group_uuid
      method: generated
      generated: '2026-10-01'