Elastic Stack (ELK Stack) User Role Assignments API
The UserRoleAssignments API from Elastic Stack (ELK Stack) — 1 operation(s) for userroleassignments.
Work with this as data
Every API 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 apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/elk-stack-userroleassignments-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: '1'
title: Elastic Cloud Enterprise User Role Assignments API
termsOfService: ''
servers:
- url: https://{{hostname}}/api/v1
security:
- basicAuth: []
- apiKey: []
tags:
- name: UserRoleAssignments
paths:
/users/{user_id}/role_assignments:
post:
tags:
- UserRoleAssignments
summary: Add Role Assignments
description: Adds a set of RoleAssignments to the specified User. Currently unavailable in self-hosted ECE.
operationId: add-role-assignments
parameters:
- name: user_id
in: path
description: Identifier for the user; include realm name and id if required
required: true
schema:
type: string
responses:
'200':
description: Role Assignments were successfully added to the target User
content:
application/json:
schema:
$ref: '#/components/schemas/EmptyResponse'
'400':
description: 'The target user Id is invalid. (code: `role_assignments.invalid_target_user_id`)'
headers:
x-cloud-error-codes:
description: The error codes associated with the response
schema:
type: string
enum:
- role_assignments.invalid_target_user_id
content:
application/json:
schema:
$ref: '#/components/schemas/BasicFailedReply'
'401':
description: 'Credentials were invalid. (code: `root.unauthorized`)'
headers:
x-cloud-error-codes:
description: The error codes associated with the response
schema:
type: string
enum:
- root.unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/BasicFailedReply'
'403':
description: 'You are not authorised to add the specified RoleAssignments. (code: `role_assignments.unauthorized_role_assignments`)'
headers:
x-cloud-error-codes:
description: The error codes associated with the response
schema:
type: string
enum:
- role_assignments.unauthorized_role_assignments
content:
application/json:
schema:
$ref: '#/components/schemas/BasicFailedReply'
x-doc:
tag: Users - Role Assignments
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoleAssignments'
description: The Role Assignments to add
required: true
delete:
tags:
- UserRoleAssignments
summary: Remove Role Assignments
description: Removes a set of RoleAssignments from the specified User. Currently unavailable in self-hosted ECE.
operationId: remove-role-assignments
parameters:
- name: user_id
in: path
description: Identifier for the user; include realm name and id if required
required: true
schema:
type: string
- name: force
in: query
description: Whether or not to force the removal of role assignments (effective only for Platform Admins)
required: false
schema:
type: boolean
default: false
responses:
'200':
description: Role Assignments were successfully removed from the target User
content:
application/json:
schema:
$ref: '#/components/schemas/EmptyResponse'
'400':
description: 'The target user Id is invalid. (code: `role_assignments.invalid_target_user_id`)'
headers:
x-cloud-error-codes:
description: The error codes associated with the response
schema:
type: string
enum:
- role_assignments.invalid_target_user_id
content:
application/json:
schema:
$ref: '#/components/schemas/BasicFailedReply'
'401':
description: 'Credentials were invalid. (code: `root.unauthorized`)'
headers:
x-cloud-error-codes:
description: The error codes associated with the response
schema:
type: string
enum:
- root.unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/BasicFailedReply'
'403':
description: 'You are not authorised to remove the specified RoleAssignments. (code: `role_assignments.unauthorized_role_assignments`)'
headers:
x-cloud-error-codes:
description: The error codes associated with the response
schema:
type: string
enum:
- role_assignments.unauthorized_role_assignments
content:
application/json:
schema:
$ref: '#/components/schemas/BasicFailedReply'
x-doc:
tag: Users - Role Assignments
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoleAssignments'
description: The Role Assignments to remove
required: true
components:
schemas:
EmptyResponse:
type: object
DeploymentRoleAssignment:
type: object
required:
- organization_id
- role_id
properties:
role_id:
type: string
description: The ID of the role that is assigned.
organization_id:
type: string
description: The ID of the organization the role is scoped to.
all:
type: boolean
description: When true, the role applies to all deployments in the organization, otherwise the role is scoped to the deployments specified in `deployment_ids`.
deployment_ids:
type: array
description: The IDs of the deployments the role is scoped to. Must be absent if `all` is true, and present if `all` is false.
items:
type: string
application_roles:
type: array
description: If provided, the user assigned this role assignment will be granted this application role when signing in to the deployment(s) specified in the role assignment.
items:
type: string
description: Assignment for a role with deployment scope.
BasicFailedReplyElement:
type: object
required:
- code
- message
properties:
code:
type: string
description: A structured code representing the error type that occurred
message:
type: string
description: A human readable message describing the error that occurred
fields:
type: array
description: If the error can be tied to a specific field or fields in the user request, this lists those fields
items:
type: string
PlatformRoleAssignment:
type: object
required:
- role_id
properties:
role_id:
type: string
description: The ID of the role that is assigned.
description: Assignment for a role with platform scope.
ProjectRoleAssignment:
type: object
required:
- organization_id
- role_id
properties:
role_id:
type: string
description: The ID of the role that is assigned.
organization_id:
type: string
description: The ID of the organization the role is scoped to.
all:
type: boolean
description: When true, the role applies to all projects in the organization, otherwise the role is scoped to the projects specified in `project_ids`.
project_ids:
type: array
description: The IDs of the projects the role is scoped to. Must be absent if `all` is true, and present if `all` is false.
items:
type: string
application_roles:
type: array
description: If provided, the user assigned this role assignment will be granted this application role when signing in to the project(s) specified in the role assignment.
items:
type: string
description: Assignment for a role with project scope.
RoleAssignments:
type: object
properties:
platform:
type: array
description: Assignments for roles with platform scope.
items:
$ref: '#/components/schemas/PlatformRoleAssignment'
organization:
type: array
description: Assignments for roles with organization scope.
items:
$ref: '#/components/schemas/OrganizationRoleAssignment'
deployment:
type: array
description: Assignments for roles with deployment scope.
items:
$ref: '#/components/schemas/DeploymentRoleAssignment'
project:
description: Assignments for roles with project scope.
$ref: '#/components/schemas/ProjectRoleAssignments'
description: Roles assigned to users, API keys or organization invitations. Currently unavailable in self-hosted ECE.
OrganizationRoleAssignment:
type: object
required:
- organization_id
- role_id
properties:
role_id:
type: string
description: The ID of the role that is assigned.
organization_id:
type: string
description: The ID of the organization the role is scoped to.
application_roles:
type: array
description: If provided, the user assigned this role assignment will be granted this application role when signing in to a deployment or project
items:
type: string
description: Assignment for a role with organization scope.
BasicFailedReply:
type: object
required:
- errors
properties:
errors:
type: array
description: A list of errors that occurred in the failing request
items:
$ref: '#/components/schemas/BasicFailedReplyElement'
ProjectRoleAssignments:
type: object
properties:
elasticsearch:
type: array
description: The Elasticsearch project-scoped role assignments to set
items:
$ref: '#/components/schemas/ProjectRoleAssignment'
observability:
type: array
description: The Observability project-scoped role assignments to set
items:
$ref: '#/components/schemas/ProjectRoleAssignment'
security:
type: array
description: The Security project-scoped role assignments to set
items:
$ref: '#/components/schemas/ProjectRoleAssignment'
workplaceai:
type: array
description: The WorkplaceAI project-scoped role assignments to set
items:
$ref: '#/components/schemas/ProjectRoleAssignment'
vectordb:
type: array
description: The VectorDB project-scoped role assignments to set
items:
$ref: '#/components/schemas/ProjectRoleAssignment'
description: Assignments for roles with project scope.
securitySchemes:
apiKey:
type: apiKey
name: Authorization
in: header
basicAuth:
type: http
scheme: basic
x-elastic:
curl:
auth: '-H "Authorization: ApiKey $ECE_API_KEY"'