Package co.elastic.clients.elasticsearch.security

Class OidcAuthenticateRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.security.OidcAuthenticateRequest.Builder

All Implemented Interfaces:

WithJson<OidcAuthenticateRequest.Builder>, ObjectBuilder<OidcAuthenticateRequest>

Enclosing class:

OidcAuthenticateRequest

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

Builder for OidcAuthenticateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OidcAuthenticateRequest	build()	Builds a OidcAuthenticateRequest.
final OidcAuthenticateRequest.Builder	nonce(String value)	Required - Associate a client session with an ID token and mitigate replay attacks.
final OidcAuthenticateRequest.Builder	realm(String value)	The name of the OpenID Connect realm.
final OidcAuthenticateRequest.Builder	redirectUri(String value)	Required - The URL to which the OpenID Connect Provider redirected the User Agent in response to an authentication request after a successful authentication.
protected OidcAuthenticateRequest.Builder	self()
final OidcAuthenticateRequest.Builder	state(String value)	Required - Maintain state between the authentication request and the response.

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

nonce

public final OidcAuthenticateRequest.Builder nonce(String value)

Required - Associate a client session with an ID token and mitigate replay attacks. This value needs to be the same as the one that was provided to the /_security/oidc/prepare API or the one that was generated by Elasticsearch and included in the response to that call.

API name: nonce

realm

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

The name of the OpenID Connect realm. This property is useful in cases where multiple realms are defined.

API name: realm

redirectUri

public final OidcAuthenticateRequest.Builder redirectUri(String value)

Required - The URL to which the OpenID Connect Provider redirected the User Agent in response to an authentication request after a successful authentication. This URL must be provided as-is (URL encoded), taken from the body of the response or as the value of a location header in the response from the OpenID Connect Provider.

API name: redirect_uri

state

public final OidcAuthenticateRequest.Builder state(String value)

Required - Maintain state between the authentication request and the response. This value needs to be the same as the one that was provided to the /_security/oidc/prepare API or the one that was generated by Elasticsearch and included in the response to that call.

API name: state

self

protected OidcAuthenticateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<OidcAuthenticateRequest.Builder>

build

public OidcAuthenticateRequest build()

Builds a OidcAuthenticateRequest.

Specified by:

build in interface ObjectBuilder<OidcAuthenticateRequest>

Throws:

NullPointerException - if some of the required fields are null.