software.amazon.awscdk.services.elasticloadbalancingv2

Interface AuthenticateOidcOptions

All Known Implementing Classes:

AuthenticateOidcOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:57.530Z")
public interface AuthenticateOidcOptions

Options for `ListenerAction.authenciateOidc()`.

Example:

 ApplicationListener listener;
 ApplicationTargetGroup myTargetGroup;
 listener.addAction("DefaultAction", AddApplicationActionProps.builder()
         .action(ListenerAction.authenticateOidc(AuthenticateOidcOptions.builder()
                 .authorizationEndpoint("https://example.com/openid")
                 // Other OIDC properties here
                 .clientId("...")
                 .clientSecret(SecretValue.secretsManager("..."))
                 .issuer("...")
                 .tokenEndpoint("...")
                 .userInfoEndpoint("...")
                 // Next
                 .next(ListenerAction.forward(List.of(myTargetGroup)))
                 .build()))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AuthenticateOidcOptions.Builder A builder for AuthenticateOidcOptions
static class	AuthenticateOidcOptions.Jsii$Proxy An implementation for AuthenticateOidcOptions

Method Summary

Modifier and Type	Method and Description
static AuthenticateOidcOptions.Builder	builder()
default java.util.Map<java.lang.String,java.lang.String>	getAuthenticationRequestExtraParams() The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
java.lang.String	getAuthorizationEndpoint() The authorization endpoint of the IdP.
java.lang.String	getClientId() The OAuth 2.0 client identifier.
SecretValue	getClientSecret() The OAuth 2.0 client secret.
java.lang.String	getIssuer() The OIDC issuer identifier of the IdP.
ListenerAction	getNext() What action to execute next.
default UnauthenticatedAction	getOnUnauthenticatedRequest() The behavior if the user is not authenticated.
default java.lang.String	getScope() The set of user claims to be requested from the IdP.
default java.lang.String	getSessionCookieName() The name of the cookie used to maintain session information.
default Duration	getSessionTimeout() The maximum duration of the authentication session.
java.lang.String	getTokenEndpoint() The token endpoint of the IdP.
java.lang.String	getUserInfoEndpoint() The user info endpoint of the IdP.

Method Detail

getAuthorizationEndpoint

java.lang.String getAuthorizationEndpoint()

The authorization endpoint of the IdP.

This must be a full URL, including the HTTPS protocol, the domain, and the path.

getClientId

java.lang.String getClientId()

The OAuth 2.0 client identifier.

getClientSecret

SecretValue getClientSecret()

The OAuth 2.0 client secret.

getIssuer

java.lang.String getIssuer()

The OIDC issuer identifier of the IdP.

This must be a full URL, including the HTTPS protocol, the domain, and the path.

getNext

ListenerAction getNext()

What action to execute next.

getTokenEndpoint

java.lang.String getTokenEndpoint()

The token endpoint of the IdP.

This must be a full URL, including the HTTPS protocol, the domain, and the path.

getUserInfoEndpoint

java.lang.String getUserInfoEndpoint()

The user info endpoint of the IdP.

This must be a full URL, including the HTTPS protocol, the domain, and the path.

getAuthenticationRequestExtraParams

default java.util.Map<java.lang.String,java.lang.String> getAuthenticationRequestExtraParams()

The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

Default: - No extra parameters

getOnUnauthenticatedRequest

default UnauthenticatedAction getOnUnauthenticatedRequest()

The behavior if the user is not authenticated.

Default: UnauthenticatedAction.AUTHENTICATE

getScope

default java.lang.String getScope()

The set of user claims to be requested from the IdP.

To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.

Default: "openid"

getSessionCookieName

default java.lang.String getSessionCookieName()

The name of the cookie used to maintain session information.

Default: "AWSELBAuthSessionCookie"

getSessionTimeout

default Duration getSessionTimeout()

The maximum duration of the authentication session.

Default: Duration.days(7)

builder

static AuthenticateOidcOptions.Builder builder()

Returns:

a AuthenticateOidcOptions.Builder of AuthenticateOidcOptions