Remove Role Assignments

Auth

Removes a set of RoleAssignments from the specified User. Currently unavailable in self-hosted ECE.

Path parameters

user_id string required

Identifier for the user; include realm name and id if required

Query parameters

force boolean · default: false

Whether or not to force the removal of role assignments (effective only for Platform Admins)

Request body

The Role Assignments to remove

platform object[]

Assignments for roles with platform scope.

role_id string required

The ID of the role that is assigned.

organization object[]

Assignments for roles with organization scope.

role_id string required

The ID of the role that is assigned.

organization_id string required

The ID of the organization the role is scoped to.

application_roles string[]

If provided, the user assigned this role assignment will be granted this application role when signing in to a deployment or project

deployment object[]

Assignments for roles with deployment scope.

role_id string required

The ID of the role that is assigned.

organization_id string required

The ID of the organization the role is scoped to.

all boolean

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 string[]

The IDs of the deployments the role is scoped to. Must be absent if all is true, and present if all is false.

application_roles string[]

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.

project object

Assignments for roles with project scope.

elasticsearch object[]

The Elasticsearch project-scoped role assignments to set

role_id string required

The ID of the role that is assigned.

organization_id string required

The ID of the organization the role is scoped to.

all boolean

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 string[]

The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.

application_roles string[]

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.

observability object[]

The Observability project-scoped role assignments to set

role_id string required

The ID of the role that is assigned.

organization_id string required

The ID of the organization the role is scoped to.

all boolean

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 string[]

The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.

application_roles string[]

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.

security object[]

The Security project-scoped role assignments to set

role_id string required

The ID of the role that is assigned.

organization_id string required

The ID of the organization the role is scoped to.

all boolean

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 string[]

The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.

application_roles string[]

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.

workplaceai object[]

The WorkplaceAI project-scoped role assignments to set

role_id string required

The ID of the role that is assigned.

organization_id string required

The ID of the organization the role is scoped to.

all boolean

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 string[]

The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.

application_roles string[]

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.

vectordb object[]

The VectorDB project-scoped role assignments to set

role_id string required

The ID of the role that is assigned.

organization_id string required

The ID of the organization the role is scoped to.

all boolean

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 string[]

The IDs of the projects the role is scoped to. Must be absent if all is true, and present if all is false.

application_roles string[]

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.

Responses

Role Assignments were successfully removed from the target User

application/json

Response Type: object

The target user Id is invalid. (code: role_assignments.invalid_target_user_id)

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

Credentials were invalid. (code: root.unauthorized)

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

You are not authorised to remove the specified RoleAssignments. (code: role_assignments.unauthorized_role_assignments)

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response