co.elastic.clients.elasticsearch.security.ActivateUserProfileRequest Maven / Gradle / Ivy
Show all versions of org.apache.servicemix.bundles.elasticsearch-java
/*
* 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.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.activate_user_profile.Request
/**
* 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 API
* specification
*/
@JsonpDeserializable
public class ActivateUserProfileRequest extends RequestBase implements JsonpSerializable {
@Nullable
private final String accessToken;
private final GrantType grantType;
@Nullable
private final String password;
@Nullable
private final String username;
// ---------------------------------------------------------------------------------------------
private ActivateUserProfileRequest(Builder builder) {
this.accessToken = builder.accessToken;
this.grantType = ApiTypeHelper.requireNonNull(builder.grantType, this, "grantType");
this.password = builder.password;
this.username = builder.username;
}
public static ActivateUserProfileRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* 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: {@code access_token}
*/
@Nullable
public final String accessToken() {
return this.accessToken;
}
/**
* Required - The type of grant.
*
* API name: {@code grant_type}
*/
public final GrantType 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 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: {@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("grant_type");
this.grantType.serialize(generator, mapper);
if (this.password != null) {
generator.writeKey("password");
generator.write(this.password);
}
if (this.username != null) {
generator.writeKey("username");
generator.write(this.username);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link ActivateUserProfileRequest}.
*/
public static class Builder extends RequestBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private String accessToken;
private GrantType grantType;
@Nullable
private String password;
@Nullable
private String username;
/**
* 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: {@code access_token}
*/
public final Builder accessToken(@Nullable String value) {
this.accessToken = value;
return this;
}
/**
* Required - The type of grant.
*
* API name: {@code grant_type}
*/
public final Builder grantType(GrantType 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 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: {@code username}
*/
public final Builder username(@Nullable String value) {
this.username = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link ActivateUserProfileRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public ActivateUserProfileRequest build() {
_checkSingleUse();
return new ActivateUserProfileRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link ActivateUserProfileRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, ActivateUserProfileRequest::setupActivateUserProfileRequestDeserializer);
protected static void setupActivateUserProfileRequestDeserializer(
ObjectDeserializer op) {
op.add(Builder::accessToken, JsonpDeserializer.stringDeserializer(), "access_token");
op.add(Builder::grantType, GrantType._DESERIALIZER, "grant_type");
op.add(Builder::password, JsonpDeserializer.stringDeserializer(), "password");
op.add(Builder::username, JsonpDeserializer.stringDeserializer(), "username");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code security.activate_user_profile}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/security.activate_user_profile",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
return "/_security/profile/_activate";
},
// Path parameters
request -> {
return Collections.emptyMap();
},
// Request parameters
request -> {
return Collections.emptyMap();
}, SimpleEndpoint.emptyMap(), true, ActivateUserProfileResponse._DESERIALIZER);
}