Drata · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drata Users and Roles API

6 actions 6 updates phrasing extends openapi/drata-users-and-roles-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Drata's API. It is a proposal applied on top of the contract, not a document Drata publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/roles'].get

$.paths['/roles/{roleId}'].get

$.paths['/roles/{roleId}/users'].get

$.paths['/users'].get

$.paths['/users/{userId}'].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 Drata Users and Roles API
  version: 1.0.0
extends: openapi/drata-users-and-roles-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles
      effect: read
      questions:
      - What roles are defined in our Drata account?
      - Which permission roles can users be given?
      instructions:
      - text: List all roles.
      - text: Show me every role in the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/roles/{roleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one role
      effect: read
      questions:
      - What does a particular role include?
      - Can I look up a role by its ID?
      instructions:
      - text: Get role {role}.
        slots:
          role: path.roleId
      - text: Show the full detail of role {role}.
        slots:
          role: path.roleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/roles/{roleId}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users who have a role
      effect: read
      questions:
      - Who has the admin role?
      - Which users are assigned a specific role?
      instructions:
      - text: List users with role {role}.
        slots:
          role: path.roleId
      - text: Find users named {last_name} who hold role {role}.
        slots:
          last_name: query.lastName
          role: path.roleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users
      effect: read
      questions:
      - Which users are in our Drata account?
      - Can I search users by first or last name?
      instructions:
      - text: List all users in the account.
      - text: Find users with first name {first_name}.
        slots:
          first_name: query.firstName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{userId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one user
      effect: read
      questions:
      - What is recorded about a specific user?
      - Can I look up a user by their ID?
      instructions:
      - text: Get user {user}.
        slots:
          user: path.userId
      - text: Show the full user record for {user}.
        slots:
          user: path.userId
      method: generated
      generated: '2026-09-26'