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.
The reason the role could not be fully transformed.
stateobject[]
applicationstringrequired
privilegesstring[]required
resourcesstring[]required
_unrecognized_applicationsstring[]
descriptionstring
A description for the role.
elasticsearchobjectrequired
The Elasticsearch cluster, index, and remote cluster security privileges for the role.
clusterstring[] · max items: 100
globalobject
Global privileges for the role.
applicationobject
manageobject
applicationsstring[] · max items: 1000required
data_sourceobject[] · max items: 1000
namesstring[] · min items: 1 · max items: 100required
privilegesenum[] · min items: 1 · max items: 5required
The data source privileges that role members have for the specified data sources.
Values:createread_metadatadeletereadmanage
profileobject
writeobject
applicationsstring[] · max items: 1000required
roleobject
Global role privileges.
indicesobject[] · max items: 1000
allow_restricted_indicesboolean
Restricted indices are a special category of indices that are used internally to store configuration data and should not be directly accessed. Only internal system roles should normally grant privileges over the restricted indices. Toggling this flag is very strongly discouraged because it could effectively grant unrestricted operations on critical data, making the entire system unstable or leaking sensitive information. If for administrative purposes you need to create a role with privileges covering restricted indices, however, you can set this property to true. In that case, the names field covers the restricted indices too.
field_securitymapstring to string
<string>string[] · max items: 1000
namesstring[] · min items: 1 · max items: 100required
privilegesstring[] · min items: 1 · max items: 100required
querystring
A search query that defines the documents the role members have read access to. A document within the specified data streams and indices must match this query in order for it to be accessible by the role members.
remote_clusterobject[] · max items: 100
clustersstring[] · min items: 1 · max items: 100required
privilegesstring[] · min items: 1 · max items: 100required
remote_indicesobject[] · max items: 1000
allow_restricted_indicesboolean
Restricted indices are a special category of indices that are used internally to store configuration data and should not be directly accessed. Only internal system roles should normally grant privileges over the restricted indices. Toggling this flag is very strongly discouraged because it could effectively grant unrestricted operations on critical data, making the entire system unstable or leaking sensitive information. If for administrative purposes you need to create a role with privileges covering restricted indices, however, you can set this property to true. In that case, the names field will cover the restricted indices too.
clustersstring[] · min items: 1 · max items: 100required
field_securitymapstring to string
<string>string[] · max items: 1000
namesstring[] · min items: 1 · max items: 100required
privilegesstring[] · min items: 1 · max items: 100required
querystring
A search query that defines the documents the role members have read access to. A document within the specified data streams and indices must match this query in order for it to be accessible by the role members.