Package co.elastic.clients.elasticsearch.security

Class ActivateUserProfileRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.ActivateUserProfileRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class ActivateUserProfileRequest
extends RequestBase
implements JsonpSerializable

Activate a user profile.

Create or update a user profile on behalf of another user.

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. The calling application must have either an access_token or a combination of username and password for the user that the profile document is intended for. Elastic reserves the right to change or remove this feature in future releases without prior notice.

This API creates or updates a profile document for end users with information that is extracted from the user's authentication object including username, full_name, roles, and the authentication realm. For example, in the JWT access_token case, the profile user's username is extracted from the JWT token claim pointed to by the claims.principal setting of the JWT realm that authenticated the token.

When updating a profile document, the API enables the document if it was disabled. Any updates do not change existing content for either the labels or data fields.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 JsonpDeserializer<ActivateUserProfileRequest>	_DESERIALIZER	Json deserializer for ActivateUserProfileRequest
static final Endpoint<ActivateUserProfileRequest,ActivateUserProfileResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.activate_user_profile".

Method Summary

Modifier and Type	Method	Description
final String	accessToken()	The user's Elasticsearch access token or JWT.
final GrantType	grantType()	Required - The type of grant.
static ActivateUserProfileRequest	of(Function<ActivateUserProfileRequest.Builder,ObjectBuilder<ActivateUserProfileRequest>> fn)
final String	password()	The user's password.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupActivateUserProfileRequestDeserializer(ObjectDeserializer<ActivateUserProfileRequest.Builder> op)
final String	username()	The username that identifies the user.

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

_DESERIALIZER

public static final JsonpDeserializer<ActivateUserProfileRequest> _DESERIALIZER

Json deserializer for ActivateUserProfileRequest

_ENDPOINT

public static final Endpoint<ActivateUserProfileRequest,ActivateUserProfileResponse,ErrorResponse> _ENDPOINT

Endpoint "security.activate_user_profile".

Method Details

of

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

accessToken

@Nullable
public final String accessToken()

The user's Elasticsearch access token or JWT. Both access and id JWT token types are supported and they depend on the underlying JWT realm configuration. If you specify the access_token grant type, this parameter is required. It is not valid with other grant types.

API name: access_token

grantType

public final GrantType grantType()

Required - The type of grant.

API name: grant_type

password

@Nullable
public final String password()

The user's password. If you specify the password grant type, this parameter is required. It is not valid with other grant types.

API name: password

username

@Nullable
public final String username()

The username that identifies the user. If you specify the password grant type, this parameter is required. It is not valid with other grant types.

API name: username

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupActivateUserProfileRequestDeserializer

protected static void setupActivateUserProfileRequestDeserializer(ObjectDeserializer<ActivateUserProfileRequest.Builder> op)