# 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 (Permissions) API
  version: 1.0.0
extends: openapi/tenable-access-control-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: 8
- target: $.paths['/api/v3/access-control/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List all access control permissions
      effect: read
      questions:
      - What access control permissions are defined in my container?
      - Can I see every permission rule across all users and groups?
      instructions:
      - text: List all access control permissions in my container.
      - text: Show me every permission defined for my organization.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/access-control/permissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an access control permission
      effect: write
      questions:
      - How do I grant a user group the ability to scan a set of tagged assets?
      - Which actions are allowed when a permission targets all assets?
      instructions:
      - text: Create permission {name} granting {actions} on {objects} to {subjects}.
        slots:
          name: requestBody.name
          actions: requestBody.actions
          objects: requestBody.objects
          subjects: requestBody.subjects
      - text: Give {subjects} the {actions} rights on {objects} under a new permission called {name}.
        slots:
          subjects: requestBody.subjects
          actions: requestBody.actions
          objects: requestBody.objects
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/access-control/permissions/{permission_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a permission
      effect: read
      questions:
      - Who does a specific permission apply to and what does it allow?
      - Can I look up one permission by its UUID?
      instructions:
      - text: Get the details of permission {permission_uuid}.
        slots:
          permission_uuid: path.permission_uuid
      - text: Show me the subjects, objects and actions of permission {permission_uuid}.
        slots:
          permission_uuid: path.permission_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/access-control/permissions/{permission_uuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Overwrite an existing permission
      effect: write
      questions:
      - Do I have to send every field when I edit a permission?
      - Can I change which assets an existing permission covers?
      instructions:
      - text: Update permission {permission_uuid} to name {name}, actions {actions}, objects {objects}, subjects {subjects}.
        slots:
          permission_uuid: path.permission_uuid
          name: requestBody.name
          actions: requestBody.actions
          objects: requestBody.objects
          subjects: requestBody.subjects
      - text: Replace the objects on permission {permission_uuid} with {objects}, keeping name {name}, actions {actions} and subjects {subjects}.
        slots:
          permission_uuid: path.permission_uuid
          objects: requestBody.objects
          name: requestBody.name
          actions: requestBody.actions
          subjects: requestBody.subjects
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/access-control/permissions/{permission_uuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a permission
      effect: destructive
      questions:
      - Can I revoke an access control permission entirely?
      - Which call removes a permission I granted by mistake?
      instructions:
      - text: Delete permission {permission_uuid}.
        slots:
          permission_uuid: path.permission_uuid
      - text: Revoke and remove access permission {permission_uuid}.
        slots:
          permission_uuid: path.permission_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/access-control/permissions/users/{user_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's permissions
      effect: read
      questions:
      - What permissions has a particular user been granted?
      - Which permissions are still available to give a specific user?
      instructions:
      - text: List the permissions for user {user_uuid}.
        slots:
          user_uuid: path.user_uuid
      - text: Show granted and available permissions for user {user_uuid}.
        slots:
          user_uuid: path.user_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/access-control/permissions/user-groups/{user_group_uuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user group's permissions
      effect: read
      questions:
      - What can members of a given user group access?
      - Which permissions are granted to a user group versus still available?
      instructions:
      - text: List the permissions for user group {user_group_uuid}.
        slots:
          user_group_uuid: path.user_group_uuid
      - text: Show granted permissions on user group {user_group_uuid}.
        slots:
          user_group_uuid: path.user_group_uuid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v3/access-control/permissions/users/me'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my own permissions
      effect: read
      questions:
      - What am I personally allowed to see and scan?
      - Can a non-admin check their own access permissions?
      instructions:
      - text: Show the permissions assigned to me.
      - text: List the access control permissions for the current API user.
      method: generated
      generated: '2026-10-01'