Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V2 Access Management Role API

5 actions 5 updates phrasing extends openapi/deputy-access-management-role-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Deputy's API. It is a proposal applied on top of the contract, not a document Deputy publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/access-management/v2/roles'].get
$.paths['/access-management/v2/roles'].post
$.paths['/access-management/v2/roles/{roleId}'].put
$.paths['/access-management/v2/roles/{roleId}'].delete

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 Deputy V2 Access Management Role API
  version: 1.0.0
extends: openapi/deputy-access-management-role-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-17'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/access-management/v2/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles
      effect: read
      questions:
      - What roles are available for assigning to people?
      - Can I see the role IDs I can assign to staff?
      instructions:
      - text: List all roles.
      - text: Show every role available.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/access-management/v2/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a role
      effect: write
      questions:
      - How do I create a new role with specific privileges?
      - Can a new role require two-factor authentication?
      instructions:
      - text: Create a role named {name}.
        slots:
          name: requestBody.name
      - text: Create role {name} that requires 2FA.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-11-17'
- target: $.paths['/access-management/v2/roles/{roleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a role
      effect: write
      questions:
      - How do I change the privileges of an existing role?
      - Can I make an existing role report to someone else?
      instructions:
      - text: Update role {roleId} with privileges {privileges}.
        slots:
          roleId: path.roleId
          privileges: requestBody.privileges
      - text: Set role {roleId} to report to {reportsTo}.
        slots:
          roleId: path.roleId
          reportsTo: requestBody.reportsTo
      method: generated
      generated: '2026-11-17'
- target: $.paths['/access-management/v2/roles/{roleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a role
      effect: destructive
      questions:
      - How do I delete a role that is no longer used?
      - Can I remove a role from the system?
      instructions:
      - text: Delete role {roleId}.
        slots:
          roleId: path.roleId
      - text: Remove the unused role {roleId}.
        slots:
          roleId: path.roleId
      method: generated
      generated: '2026-11-17'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/deputy-access-management-role-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.