roles

Create or update a role

Changed on

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}

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/security/role/{name}
  • Auth
    • API key in header Authorization
    • or HTTP basic

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.

Changes