v53

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-076771,7565.2 MB
roles

Create or update a role

Create a new Kibana role or update the attributes of an existing role. Kibana roles are stored in the Elasticsearch native realm.

put/api/security/role/{name}

Path parameters

namestring required

The role name.

Query parameters

createOnlyboolean

When true, a role is not overwritten if it already exists.

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

descriptionstring

A description for the role.

metadataobject

Response

Indicates a successful call.