Search + K

Command Palette

Search for a command to run...

Sign In

Bulk create or update roles

POST /_security/role
Copy endpoint

The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk create or update roles API cannot update roles that are defined in roles files.

Required authorization

  • Cluster privileges: manage_security

Parameters

query Query Parameters

Name Type
refresh

If true (the default) then refresh the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false then do nothing with refreshes.

type TypesRefresh = "true" | "false" | "wait_for"

Request Body

application/json required
{ roles: { }; }

Responses

200 application/json
{
created?: string[];
updated?: string[];
noop?: string[];
errors?: SecurityTypesBulkError
interface SecurityTypesBulkError {
count: number;
details: { };
}
;
}