Package co.elastic.clients.elasticsearch.security

Class AuthenticateRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.AuthenticateRequest

public class AuthenticateRequest
extends RequestBase

Authenticate a user.

Authenticates a user and returns information about the authenticated user. Include the user information in a basic auth header. A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. If the user cannot be authenticated, this API returns a 401 status code.

See Also:

• API specification

Nested Class Summary

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<AuthenticateRequest,AuthenticateResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.authenticate".
static final AuthenticateRequest	_INSTANCE	Singleton instance for AuthenticateRequest.

Constructor Summary

Constructors

Constructor	Description
AuthenticateRequest()

Method Summary

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

_INSTANCE

public static final AuthenticateRequest _INSTANCE

Singleton instance for AuthenticateRequest.

_ENDPOINT

public static final Endpoint<AuthenticateRequest,AuthenticateResponse,ErrorResponse> _ENDPOINT

Endpoint "security.authenticate".

Constructor Details

AuthenticateRequest

public AuthenticateRequest()