Package co.elastic.clients.elasticsearch.security

Class GetUserRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.GetUserRequest

public class GetUserRequest
extends RequestBase

Get users.

Get information about users in the native realm and built-in users.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<GetUserRequest,GetUserResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.get_user".

Method Summary

Modifier and Type	Method	Description
static GetUserRequest	of(Function<GetUserRequest.Builder,ObjectBuilder<GetUserRequest>> fn)
final List<String>	username()	An identifier for the user.
final Boolean	withProfileUid()	Determines whether to retrieve the user profile UID, if it exists, for the users.

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<GetUserRequest,GetUserResponse,ErrorResponse> _ENDPOINT

Endpoint "security.get_user".

Method Details

of

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

username

public final List<String> username()

An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves information about all users.

API name: username

withProfileUid

@Nullable
public final Boolean withProfileUid()

Determines whether to retrieve the user profile UID, if it exists, for the users.

API name: with_profile_uid