Create or Update Roleedit
This API is experimental and may be changed or removed completely in a future release. Although the underlying mechanism of enforcing role-based access control is stable, the APIs for managing the roles are currently experimental.
Creates a new Kibana role or updates the attributes of an existing role. Kibana roles are stored in the Elasticsearch native realm.
You cannot access this endpoint via the Console in Kibana.
Authorizationedit
To use this API, you must have at least the manage_security cluster privilege.
Requestedit
To create or update a role, issue a PUT request to the
/api/security/role/<rolename> endpoint.
PUT /api/security/role/my_kibana_role
Request Bodyedit
The following parameters can be specified in the body of a PUT request to add or update a role:
-
metadata -
(object) Optional meta-data. Within the
metadataobject, keys that begin with_are reserved for system usage. -
elasticsearch -
(object) Optional Elasticsearch cluster and index privileges, valid keys are
cluster,indicesandrun_as. For more information, see Defining roles. -
kibana -
(list) A list of objects that specifies the Kibana privileges for this role:
-
base -
(list) An optional base privilege. If specified, must either be
["all"]or["read"]. Thefeaturesection cannot be used if a base privilege is specified here. You must use one or the other. "all" grants read/write access to all Kibana features for the specified spaces. "read" grants read-only access to all Kibana features for the specified spaces. -
feature -
(object) Object containing privileges for specific features.
The
basesection cannot be used if feature privileges are specified here. You must use one or the other. Use the Features API to retrieve a list of available features. -
spaces -
(list) The spaces these privileges should be applied to.
To grant access to all spaces, set this to
["*"], or omit the value.
-
Example 1edit
Granting access to various features in all spaces.
PUT /api/security/role/my_kibana_role
{
"metadata" : {
"version" : 1
},
"elasticsearch": {
"cluster" : [ ],
"indices" : [ ]
},
"kibana": [
{
"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": [
"*"
]
}
]
}
Example 2edit
Granting "dashboard only" access to only the Marketing space.
PUT /api/security/role/my_kibana_role
{
"metadata" : {
"version" : 1
},
"elasticsearch": {
"cluster" : [ ],
"indices" : [ ]
},
"kibana": [
{
"base": [],
"feature": {
"dashboard": ["read"]
},
"spaces": [
"marketing"
]
}
]
}
Example 3edit
Granting full access to all features in the Default space.
PUT /api/security/role/my_kibana_role
{
"metadata" : {
"version" : 1
},
"elasticsearch": {
"cluster" : [ ],
"indices" : [ ]
},
"kibana": [
{
"base": ["all"],
"feature": {
},
"spaces": [
"default"
]
}
]
}
Example 4edit
Granting different access to different spaces.
PUT /api/security/role/my_kibana_role
{
"metadata" : {
"version" : 1
},
"elasticsearch": {
"cluster" : [ ],
"indices" : [ ]
},
"kibana": [
{
"base": [],
"feature": {
"discover": ["all"],
"dashboard": ["all"]
},
"spaces": [
"default"
]
},
{
"base": ["read"],
"spaces": [
"marketing",
"sales"
]
}
]
}
Example 5edit
Granting access to both Kibana and Elasticsearch.
PUT /api/security/role/my_kibana_role
{
"metadata" : {
"version" : 1
},
"elasticsearch": {
"cluster" : [ "all" ],
"indices" : [ {
"names" : [ "index1", "index2" ],
"privileges" : [ "all" ],
"field_security" : {
"grant" : [ "title", "body" ]
},
"query" : "{\"match\": {\"title\": \"foo\"}}"
} ]
},
"kibana": [
{
"base": ["all"],
"feature": {
},
"spaces": [
"default"
]
}
]
}
Responseedit
A successful call returns a response code of 204 and no response body.