1e3f14395c
* [DOCS] API intro * Logstash configuration management * Reformatting * Comments from Josh * Commets from Gail * Fixed broken things
111 lines
2 KiB
Plaintext
111 lines
2 KiB
Plaintext
[[role-management-specific-api-get]]
|
|
=== Get specific role API
|
|
++++
|
|
<titleabbrev>Get specific role</titleabbrev>
|
|
++++
|
|
|
|
Retrieve a specific role.
|
|
|
|
experimental["The underlying mechanism of enforcing role-based access control is stable, but the APIs for managing the roles are experimental."]
|
|
|
|
[[role-management-specific-api-get-prereqs]]
|
|
==== Prerequisite
|
|
|
|
To use the get specific role API, you must have the `manage_security` cluster privilege.
|
|
|
|
[[role-management-specific-api-retrieve-all-request-body]]
|
|
===== Request
|
|
|
|
`GET /api/security/role/my_restricted_kibana_role`
|
|
|
|
[[role-management-specific-api-retrieve-all-response-codes]]
|
|
==== Response code
|
|
|
|
`200`::
|
|
Indicates a successful call.
|
|
|
|
[[role-management-specific-api-retrieve-all-example]]
|
|
===== Example
|
|
|
|
The API returns the following:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
"name": "my_restricted_kibana_role",
|
|
"metadata" : {
|
|
"version" : 1
|
|
},
|
|
"transient_metadata": {
|
|
"enabled": true
|
|
},
|
|
"elasticsearch": {
|
|
"cluster": [ ],
|
|
"indices": [ ],
|
|
"run_as": [ ]
|
|
},
|
|
"kibana": [
|
|
{
|
|
"base": [
|
|
"read"
|
|
],
|
|
"feature": {},
|
|
"spaces": [
|
|
"marketing"
|
|
]
|
|
},
|
|
{
|
|
"base": [],
|
|
"feature": {
|
|
"discover": [
|
|
"all"
|
|
],
|
|
"visualize": [
|
|
"all"
|
|
],
|
|
"dashboard": [
|
|
"all"
|
|
],
|
|
"dev_tools": [
|
|
"read"
|
|
],
|
|
"advancedSettings": [
|
|
"read"
|
|
],
|
|
"indexPatterns": [
|
|
"read"
|
|
],
|
|
"timelion": [
|
|
"all"
|
|
],
|
|
"graph": [
|
|
"all"
|
|
],
|
|
"apm": [
|
|
"read"
|
|
],
|
|
"maps": [
|
|
"read"
|
|
],
|
|
"canvas": [
|
|
"read"
|
|
],
|
|
"infrastructure": [
|
|
"all"
|
|
],
|
|
"logs": [
|
|
"all"
|
|
],
|
|
"uptime": [
|
|
"all"
|
|
]
|
|
},
|
|
"spaces": [
|
|
"sales",
|
|
"default"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
--------------------------------------------------
|