Files
elasticsearch-js/docs/reference-security-get_user_privileges.asciidoc
2024-12-05 14:46:46 -06:00

69 lines
4.1 KiB
Plaintext

[[reference-security-get_user_privileges]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
=== client.security.getUserPrivileges
Get user privileges.
{ref}/security-api-get-user-privileges.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(SecurityGetUserPrivilegesRequest, options?): Promise<SecurityGetUserPrivilegesResponse>
----
[discrete]
===== `SecurityGetUserPrivilegesRequest`
[source,ts]
----
interface SecurityGetUserPrivilegesRequest extends <<shared-type-request-base, RequestBase>> {
application?: <<shared-type-name, Name>>
priviledge?: <<shared-type-name, Name>>
username?: <<shared-type-name, Name>> | null
}
----
[discrete]
===== `SecurityGetUserPrivilegesResponse`
[source,ts]
----
interface SecurityGetUserPrivilegesResponse {
applications: SecurityApplicationPrivileges[]
cluster: string[]
global: SecurityGlobalPrivilege[]
indices: SecurityUserIndicesPrivileges[]
run_as: string[]
}
----