roles

Get all roles

Changed on

Retrieve all Kibana roles.

get/api/security/role

Request

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

Query parameters

includeReservedRolesboolean

If true, include built-in roles on serverless. By default, serverless returns only custom roles. Other deployments always include built-in roles.

replaceDeprecatedPrivilegesboolean

If true and the response contains any privileges that are associated with deprecated features, they are omitted in favor of details about the appropriate replacement feature privileges.

Response

Indicates a successful call.

_unrecognized_applicationsstring[]
descriptionstring

A description for the role.

metadataobject
namestring required

The role name.

transient_metadataobject

Changes