roles

Get a role

Changed on

Retrieve a Kibana role by its name.

get/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

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