Package co.elastic.clients.elasticsearch.security

Class HasPrivilegesUserProfileRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.HasPrivilegesUserProfileRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class HasPrivilegesUserProfileRequest
extends RequestBase
implements JsonpSerializable

Check user profile privileges.

Determine whether the users associated with the specified user profile IDs have all the requested privileges.

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.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<HasPrivilegesUserProfileRequest>	_DESERIALIZER	Json deserializer for HasPrivilegesUserProfileRequest
static final Endpoint<HasPrivilegesUserProfileRequest,HasPrivilegesUserProfileResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.has_privileges_user_profile".

Method Summary

Modifier and Type	Method	Description
static HasPrivilegesUserProfileRequest	of(Function<HasPrivilegesUserProfileRequest.Builder,ObjectBuilder<HasPrivilegesUserProfileRequest>> fn)
final PrivilegesCheck	privileges()	Required - An object containing all the privileges to be checked.
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	setupHasPrivilegesUserProfileRequestDeserializer(ObjectDeserializer<HasPrivilegesUserProfileRequest.Builder> op)
final List<String>	uids()	Required - A list of profile IDs.

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<HasPrivilegesUserProfileRequest> _DESERIALIZER

Json deserializer for HasPrivilegesUserProfileRequest

_ENDPOINT

public static final Endpoint<HasPrivilegesUserProfileRequest,HasPrivilegesUserProfileResponse,ErrorResponse> _ENDPOINT

Endpoint "security.has_privileges_user_profile".

Method Details

of

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

privileges

public final PrivilegesCheck privileges()

Required - An object containing all the privileges to be checked.

API name: privileges

uids

public final List<String> uids()

Required - A list of profile IDs. The privileges are checked for associated users of the profiles.

API name: uids

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)

setupHasPrivilegesUserProfileRequestDeserializer

protected static void setupHasPrivilegesUserProfileRequestDeserializer(ObjectDeserializer<HasPrivilegesUserProfileRequest.Builder> op)