AuthThe Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.AvailabilityGenerally available since 8.3This functionality is generally available and ready for production usage.Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
Determine whether the users associated with the specified user profile IDs have all the requested privileges.
Note
The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly.
Elastic reserves the right to change or remove this feature in future releases without prior notice.
A list of profile IDs. The privileges are checked for associated users of the profiles.
privilegesobjectrequired
An object containing all the privileges to be checked.
applicationobject[]
applicationstringrequired
The name of the application.
privilegesstring[]required
A list of the privileges that you want to check for the specified resources.
It may be either application privilege names or the names of actions that are granted by those privileges
resourcesstring[]required
A list of resource names against which the privileges should be checked.
clusterunionanyOf[]
A list of the cluster privileges that you want to check.
This needs to be set to true (default is false) if using wildcards or regexps for patterns that cover restricted indices.
Implicitly, restricted indices do not match index patterns because restricted indices usually have limited privileges and including them in pattern tests would render most such tests false.
If restricted indices are explicitly included in the names list, privileges will be checked against them regardless of the value of allow_restricted_indices.
The subset of the requested profile IDs of the users that
have all the requested privileges.
errorsobject
The subset of the requested profile IDs for which an error
was encountered. It does not include the missing profile IDs
or the profile IDs of the users that do not have all the
requested privileges. This field is absent if empty.
countnumberrequired
detailsmapstring to objectrequired
<string>object
typestringrequired
The type of error
reasonunionstringnullable
A human-readable explanation of the error, in English.
One of:string
stack_tracestring
The server stack trace. Present only if the error_trace=true parameter was sent with the request.