Package co.elastic.clients.elasticsearch.security

Class GetUserPrivilegesRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.GetUserPrivilegesRequest

public class GetUserPrivilegesRequest
extends RequestBase

Get user privileges.

Get the security privileges for the logged in user. All users can use this API, but only to determine their own privileges. To check the privileges of other users, you must use the run as feature. To check whether a user has a specific list of privileges, use the has privileges API.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetUserPrivilegesRequest.Builder	Builder for GetUserPrivilegesRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<GetUserPrivilegesRequest,GetUserPrivilegesResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.get_user_privileges".

Method Summary

Modifier and Type	Method	Description
final String	application()	The name of the application.
static GetUserPrivilegesRequest	of(Function<GetUserPrivilegesRequest.Builder,ObjectBuilder<GetUserPrivilegesRequest>> fn)
final String	priviledge()	The name of the privilege.
final String	username()	API name: username

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<GetUserPrivilegesRequest,GetUserPrivilegesResponse,ErrorResponse> _ENDPOINT

Endpoint "security.get_user_privileges".

Method Details

of

public static GetUserPrivilegesRequest of(Function<GetUserPrivilegesRequest.Builder,ObjectBuilder<GetUserPrivilegesRequest>> fn)

application

@Nullable
public final String application()

The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, the API returns information about all privileges for all applications.

API name: application

priviledge

@Nullable
public final String priviledge()

The name of the privilege. If you do not specify this parameter, the API returns information about all privileges for the requested application.

API name: priviledge

username

@Nullable
public final String username()

API name: username