@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-31T18:36:57.530Z")
public interface AuthenticateOidcOptions
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());
Modifier and Type | Interface and Description |
---|---|
static class |
AuthenticateOidcOptions.Builder
A builder for
AuthenticateOidcOptions |
static class |
AuthenticateOidcOptions.Jsii$Proxy
An implementation for
AuthenticateOidcOptions |
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.
|
java.lang.String getAuthorizationEndpoint()
This must be a full URL, including the HTTPS protocol, the domain, and the path.
java.lang.String getClientId()
SecretValue getClientSecret()
java.lang.String getIssuer()
This must be a full URL, including the HTTPS protocol, the domain, and the path.
ListenerAction getNext()
java.lang.String getTokenEndpoint()
This must be a full URL, including the HTTPS protocol, the domain, and the path.
java.lang.String getUserInfoEndpoint()
This must be a full URL, including the HTTPS protocol, the domain, and the path.
default java.util.Map<java.lang.String,java.lang.String> getAuthenticationRequestExtraParams()
Default: - No extra parameters
default UnauthenticatedAction getOnUnauthenticatedRequest()
Default: UnauthenticatedAction.AUTHENTICATE
default java.lang.String getScope()
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
Default: "openid"
default java.lang.String getSessionCookieName()
Default: "AWSELBAuthSessionCookie"
default Duration getSessionTimeout()
Default: Duration.days(7)
static AuthenticateOidcOptions.Builder builder()
AuthenticateOidcOptions.Builder
of AuthenticateOidcOptions