Get a role
Base URL
https://{kibana_url}
Auth
Expand all
name
string · min length: 1 required
The role name.
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.
200
Indicates a successful call.
application/json
Thank you for your feedback.
Base URL
https://{kibana_url}
Examples
Request
Console
1 / 2 languages
‹
›
1
GET kbn:/api/security/role/NAME
Generated from the API spec
1
2
curl -X GET "${KIBANA_URL}/api/security/role/${NAME}" \
-H "Authorization: ApiKey ${API_KEY}"
Generated from the API spec
Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
{
"name": "my_kibana_role",
"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.",
"metadata": {
"version": 1
},
"transient_metadata": {
"enabled": true
},
"elasticsearch": {
"cluster": [
"all"
],
"remote_cluster": [
{
"privileges": [
"monitor_enrich"
],
"clusters": [
"remote_cluster1"
]
}
],
"indices": [
{
"names": [
"index1",
"index2"
],
"privileges": [
"all"
],
"allow_restricted_indices": false
}
],
"remote_indices": [
{
"names": [
"remote_index1",
"remote_index2"
],
"privileges": [
"all"
],
"allow_restricted_indices": false,
"clusters": [
"remote_cluster1"
]
}
],
"run_as": []
},
"kibana": [
{
"base": [
"all"
],
"feature": {},
"spaces": [
"default"
]
}
],
"_transform_error": [],
"_unrecognized_applications": []
}