Package co.elastic.clients.elasticsearch.security

Class DisableUserProfileRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.DisableUserProfileRequest

public class DisableUserProfileRequest
extends RequestBase

Disable a user profile.

Disable user profiles so that they are not visible in user profile searches.

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. Elastic reserves the right to change or remove this feature in future releases without prior notice.

When you activate a user profile, its automatically enabled and visible in user profile searches. You can use the disable user profile API to disable a user profile so it’s not visible in these searches. To re-enable a disabled user profile, use the enable user profile API .

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<DisableUserProfileRequest,DisableUserProfileResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.disable_user_profile".

Method Summary

Modifier and Type	Method	Description
static DisableUserProfileRequest	of(Function<DisableUserProfileRequest.Builder,ObjectBuilder<DisableUserProfileRequest>> fn)
final Refresh	refresh()	If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.
final String	uid()	Required - Unique identifier for the user profile.

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<DisableUserProfileRequest,DisableUserProfileResponse,ErrorResponse> _ENDPOINT

Endpoint "security.disable_user_profile".

Method Details

of

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

refresh

@Nullable
public final Refresh refresh()

If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', it does nothing with refreshes.

API name: refresh

uid

public final String uid()

Required - Unique identifier for the user profile.

API name: uid