Get a role

GET /api/security/role/{name}
Api key auth Basic auth

Path parameters

  • name string Required

    The role name.

    Minimum length is 1.

Query parameters

  • replaceDeprecatedPrivileges boolean

    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.

Responses

  • 200 application/json

    Indicates a successful call.

GET /api/security/role/{name} 
curl \ --request GET 'https://localhost:5601/api/security/role/{name}' \ --header "Authorization: $API_KEY"
Response examples (200) 
{ "name": "my_kibana_role", "kibana": [ { "base": [ "all" ], "spaces": [ "default" ], "feature": {} } ], "metadata": { "version": 1 }, "description": "Grants all cluster privileges and full access to index1 and index2. Grants full access to remote_index1 and remote_index2, and the monitor_enrich cluster privilege on remote_cluster1. Grants all Kibana privileges in the default space.", "elasticsearch": { "run_as": [], "cluster": [ "all" ], "indices": [ { "names": [ "index1", "index2" ], "privileges": [ "all" ], "allow_restricted_indices": false } ], "remote_cluster": [ { "clusters": [ "remote_cluster1" ], "privileges": [ "monitor_enrich" ] } ], "remote_indices": [ { "names": [ "remote_index1", "remote_index2" ], "clusters": [ "remote_cluster1" ], "privileges": [ "all" ], "allow_restricted_indices": false } ] }, "_transform_error": [], "transient_metadata": { "enabled": true }, "_unrecognized_applications": [] }