co.elastic.clients.elasticsearch.security.GrantApiKeyRequest Maven / Gradle / Ivy
Show all versions of elasticsearch-java Show documentation
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package co.elastic.clients.elasticsearch.security;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.elasticsearch.security.grant_api_key.ApiKeyGrantType;
import co.elastic.clients.elasticsearch.security.grant_api_key.GrantApiKey;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.transport.Endpoint;
import co.elastic.clients.transport.endpoints.SimpleEndpoint;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import jakarta.json.stream.JsonGenerator;
import java.lang.String;
import java.util.Collections;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
// typedef: security.grant_api_key.Request
/**
* Creates an API key on behalf of another user. This API is similar to Create
* API keys, however it creates the API key for a user that is different than
* the user that runs the API. The caller must have authentication credentials
* (either an access token, or a username and password) for the user on whose
* behalf the API key will be created. It is not possible to use this API to
* create an API key without that user’s credentials. The user, for whom the
* authentication credentials is provided, can optionally "run as"
* (impersonate) another user. In this case, the API key will be created on
* behalf of the impersonated user.
*
* This API is intended be used by applications that need to create and manage
* API keys for end users, but cannot guarantee that those users have permission
* to create API keys on their own behalf.
*
* A successful grant API key API call returns a JSON structure that contains
* the API key, its unique id, and its name. If applicable, it also returns
* expiration information for the API key in milliseconds.
*
* By default, API keys never expire. You can specify expiration information
* when you create the API keys.
*
* @see API
* specification
*/
@JsonpDeserializable
public class GrantApiKeyRequest extends RequestBase implements JsonpSerializable {
@Nullable
private final String accessToken;
private final GrantApiKey apiKey;
private final ApiKeyGrantType grantType;
@Nullable
private final String password;
@Nullable
private final String runAs;
@Nullable
private final String username;
// ---------------------------------------------------------------------------------------------
private GrantApiKeyRequest(Builder builder) {
this.accessToken = builder.accessToken;
this.apiKey = ApiTypeHelper.requireNonNull(builder.apiKey, this, "apiKey");
this.grantType = ApiTypeHelper.requireNonNull(builder.grantType, this, "grantType");
this.password = builder.password;
this.runAs = builder.runAs;
this.username = builder.username;
}
public static GrantApiKeyRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* The user’s access token. If you specify the access_token grant
* type, this parameter is required. It is not valid with other grant types.
*
* API name: {@code access_token}
*/
@Nullable
public final String accessToken() {
return this.accessToken;
}
/**
* Required - Defines the API key.
*
* API name: {@code api_key}
*/
public final GrantApiKey apiKey() {
return this.apiKey;
}
/**
* Required - The type of grant. Supported grant types are:
* access_token, password.
*
* API name: {@code grant_type}
*/
public final ApiKeyGrantType grantType() {
return this.grantType;
}
/**
* 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: {@code password}
*/
@Nullable
public final String password() {
return this.password;
}
/**
* The name of the user to be impersonated.
*
* API name: {@code run_as}
*/
@Nullable
public final String runAs() {
return this.runAs;
}
/**
* The user name 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: {@code username}
*/
@Nullable
public final String username() {
return this.username;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
if (this.accessToken != null) {
generator.writeKey("access_token");
generator.write(this.accessToken);
}
generator.writeKey("api_key");
this.apiKey.serialize(generator, mapper);
generator.writeKey("grant_type");
this.grantType.serialize(generator, mapper);
if (this.password != null) {
generator.writeKey("password");
generator.write(this.password);
}
if (this.runAs != null) {
generator.writeKey("run_as");
generator.write(this.runAs);
}
if (this.username != null) {
generator.writeKey("username");
generator.write(this.username);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link GrantApiKeyRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private String accessToken;
private GrantApiKey apiKey;
private ApiKeyGrantType grantType;
@Nullable
private String password;
@Nullable
private String runAs;
@Nullable
private String username;
/**
* The user’s access token. If you specify the access_token grant
* type, this parameter is required. It is not valid with other grant types.
*
* API name: {@code access_token}
*/
public final Builder accessToken(@Nullable String value) {
this.accessToken = value;
return this;
}
/**
* Required - Defines the API key.
*
* API name: {@code api_key}
*/
public final Builder apiKey(GrantApiKey value) {
this.apiKey = value;
return this;
}
/**
* Required - Defines the API key.
*
* API name: {@code api_key}
*/
public final Builder apiKey(Function> fn) {
return this.apiKey(fn.apply(new GrantApiKey.Builder()).build());
}
/**
* Required - The type of grant. Supported grant types are:
* access_token, password.
*
* API name: {@code grant_type}
*/
public final Builder grantType(ApiKeyGrantType value) {
this.grantType = value;
return this;
}
/**
* 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: {@code password}
*/
public final Builder password(@Nullable String value) {
this.password = value;
return this;
}
/**
* The name of the user to be impersonated.
*
* API name: {@code run_as}
*/
public final Builder runAs(@Nullable String value) {
this.runAs = value;
return this;
}
/**
* The user name 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: {@code username}
*/
public final Builder username(@Nullable String value) {
this.username = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link GrantApiKeyRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public GrantApiKeyRequest build() {
_checkSingleUse();
return new GrantApiKeyRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link GrantApiKeyRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, GrantApiKeyRequest::setupGrantApiKeyRequestDeserializer);
protected static void setupGrantApiKeyRequestDeserializer(ObjectDeserializer op) {
op.add(Builder::accessToken, JsonpDeserializer.stringDeserializer(), "access_token");
op.add(Builder::apiKey, GrantApiKey._DESERIALIZER, "api_key");
op.add(Builder::grantType, ApiKeyGrantType._DESERIALIZER, "grant_type");
op.add(Builder::password, JsonpDeserializer.stringDeserializer(), "password");
op.add(Builder::runAs, JsonpDeserializer.stringDeserializer(), "run_as");
op.add(Builder::username, JsonpDeserializer.stringDeserializer(), "username");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code security.grant_api_key}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/security.grant_api_key",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
return "/_security/api_key/grant";
},
// Path parameters
request -> {
return Collections.emptyMap();
},
// Request parameters
request -> {
return Collections.emptyMap();
}, SimpleEndpoint.emptyMap(), true, GrantApiKeyResponse._DESERIALIZER);
}