Package co.elastic.clients.elasticsearch.security

Class OidcPrepareAuthenticationRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<OidcPrepareAuthenticationRequest.Builder>

co.elastic.clients.elasticsearch.security.OidcPrepareAuthenticationRequest.Builder

All Implemented Interfaces:

WithJson<OidcPrepareAuthenticationRequest.Builder>, ObjectBuilder<OidcPrepareAuthenticationRequest>

Enclosing class:

OidcPrepareAuthenticationRequest

public static class OidcPrepareAuthenticationRequest.Builder
extends RequestBase.AbstractBuilder<OidcPrepareAuthenticationRequest.Builder>
implements ObjectBuilder<OidcPrepareAuthenticationRequest>

Builder for OidcPrepareAuthenticationRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OidcPrepareAuthenticationRequest	build()	Builds a OidcPrepareAuthenticationRequest.
final OidcPrepareAuthenticationRequest.Builder	iss(String value)	In the case of a third party initiated single sign on, this is the issuer identifier for the OP that the RP is to send the authentication request to.
final OidcPrepareAuthenticationRequest.Builder	loginHint(String value)	In the case of a third party initiated single sign on, it is a string value that is included in the authentication request as the login_hint parameter.
final OidcPrepareAuthenticationRequest.Builder	nonce(String value)	The value used to associate a client session with an ID token and to mitigate replay attacks.
final OidcPrepareAuthenticationRequest.Builder	realm(String value)	The name of the OpenID Connect realm in Elasticsearch the configuration of which should be used in order to generate the authentication request.
protected OidcPrepareAuthenticationRequest.Builder	self()
final OidcPrepareAuthenticationRequest.Builder	state(String value)	The value used to maintain state between the authentication request and the response, typically used as a Cross-Site Request Forgery mitigation.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

iss

public final OidcPrepareAuthenticationRequest.Builder iss(@Nullable
 String value)

In the case of a third party initiated single sign on, this is the issuer identifier for the OP that the RP is to send the authentication request to. It cannot be specified when realm is specified. One of realm or iss is required.

API name: iss

loginHint

public final OidcPrepareAuthenticationRequest.Builder loginHint(@Nullable
 String value)

In the case of a third party initiated single sign on, it is a string value that is included in the authentication request as the login_hint parameter. This parameter is not valid when realm is specified.

API name: login_hint

nonce

public final OidcPrepareAuthenticationRequest.Builder nonce(@Nullable
 String value)

The value used to associate a client session with an ID token and to mitigate replay attacks. If the caller of the API does not provide a value, Elasticsearch will generate one with sufficient entropy and return it in the response.

API name: nonce

realm

public final OidcPrepareAuthenticationRequest.Builder realm(@Nullable
 String value)

The name of the OpenID Connect realm in Elasticsearch the configuration of which should be used in order to generate the authentication request. It cannot be specified when iss is specified. One of realm or iss is required.

API name: realm

state

public final OidcPrepareAuthenticationRequest.Builder state(@Nullable
 String value)

The value used to maintain state between the authentication request and the response, typically used as a Cross-Site Request Forgery mitigation. If the caller of the API does not provide a value, Elasticsearch will generate one with sufficient entropy and return it in the response.

API name: state

self

protected OidcPrepareAuthenticationRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<OidcPrepareAuthenticationRequest.Builder>

build

public OidcPrepareAuthenticationRequest build()

Builds a OidcPrepareAuthenticationRequest.

Specified by:

build in interface ObjectBuilder<OidcPrepareAuthenticationRequest>

Throws:

NullPointerException - if some of the required fields are null.