Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Elastic Cloud Enterprise User Role Assignments API

3 actions 3 updates phrasing extends openapi/elk-stack-userroleassignments-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Elastic Stack's API. It is a proposal applied on top of the contract, not a document Elastic Stack publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/users/{user_id}/role_assignments'].post
$.paths['/users/{user_id}/role_assignments'].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 Elastic Cloud Enterprise User Role Assignments API
  version: 1.0.0
extends: openapi/elk-stack-userroleassignments-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: 2
- target: $.paths['/users/{user_id}/role_assignments'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant role assignments to a user
      effect: write
      questions:
      - How do I give a user a deployment-scoped role in Elastic Cloud?
      - Can I assign organization and platform roles to someone in the same request?
      - Is adding role assignments available on self-hosted ECE?
      instructions:
      - text: Give user {user_id} the deployment role assignments {deployment}.
        slots:
          user_id: path.user_id
          deployment: requestBody.deployment
      - text: Add organization role assignments {organization} to user {user_id}.
        slots:
          organization: requestBody.organization
          user_id: path.user_id
      - text: Grant {user_id} the project-scoped roles {project}.
        slots:
          user_id: path.user_id
          project: requestBody.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_id}/role_assignments'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke role assignments from a user
      effect: destructive
      questions:
      - How do I take a deployment role away from a user?
      - Can I force removal of a platform role assignment from someone?
      instructions:
      - text: Remove the deployment role assignments {deployment} from user {user_id}.
        slots:
          deployment: requestBody.deployment
          user_id: path.user_id
      - text: Revoke platform roles {platform} from {user_id} with force set to {force}.
        slots:
          platform: requestBody.platform
          user_id: path.user_id
          force: query.force
      method: generated
      generated: '2026-09-26'