Package co.elastic.clients.elasticsearch.security

Class BulkUpdateApiKeysRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.security.BulkUpdateApiKeysRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class BulkUpdateApiKeysRequest extends RequestBase implements JsonpSerializable
Bulk update API keys. Update the attributes for multiple API keys.

IMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required.

This API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates.

It is not possible to update expired or invalidated API keys.

This API supports updates to API key access scope, metadata and expiration. The access scope of each API key is derived from the role_descriptors you specify in the request and a snapshot of the owner user's permissions at the time of the request. The snapshot of the owner's permissions is updated automatically on every call.

IMPORTANT: If you don't specify role_descriptors in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified.

A successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update.

See Also:

  • Field Details

  • Method Details

    • of

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

    • expiration

      @Nullable public final Time expiration()
      Expiration time for the API keys. By default, API keys never expire. This property can be omitted to leave the value unchanged.

      API name: expiration

    • ids

      public final List<String> ids()
      Required - The API key identifiers.

      API name: ids

    • metadata

      public final Map<String,JsonData> metadata()
      Arbitrary nested metadata to associate with the API keys. Within the metadata object, top-level keys beginning with an underscore (_) are reserved for system usage. Any information specified with this parameter fully replaces metadata previously associated with the API key.

      API name: metadata

    • roleDescriptors

      public final Map<String,RoleDescriptor> roleDescriptors()
      The role descriptors to assign to the API keys. An API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of permissions of the owner user. You can assign new privileges by specifying them in this parameter. To remove assigned privileges, supply the role_descriptors parameter as an empty object {}. If an API key has no assigned privileges, it inherits the owner user's full permissions. The snapshot of the owner's permissions is always updated, whether you supply the role_descriptors parameter. The structure of a role descriptor is the same as the request for the create API keys API.

      API name: role_descriptors

    • 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)

    • setupBulkUpdateApiKeysRequestDeserializer

      protected static void setupBulkUpdateApiKeysRequestDeserializer(ObjectDeserializer<BulkUpdateApiKeysRequest.Builder> op)