Interface IAuthenticateOidcOptions
Options for ListenerAction.authenciateOidc().
Namespace: Amazon.CDK.AWS.ElasticLoadBalancingV2
Assembly: Amazon.CDK.AWS.ElasticLoadBalancingV2.dll
Syntax (csharp)
public interface IAuthenticateOidcOptionsSyntax (vb)
Public Interface IAuthenticateOidcOptionsSynopsis
Properties
| AuthenticationRequestExtraParams | The query parameters (up to 10) to include in the redirect request to the authorization endpoint. |
| AuthorizationEndpoint | The authorization endpoint of the IdP. |
| ClientId | The OAuth 2.0 client identifier. |
| ClientSecret | The OAuth 2.0 client secret. |
| Issuer | The OIDC issuer identifier of the IdP. |
| Next | What action to execute next. |
| OnUnauthenticatedRequest | The behavior if the user is not authenticated. |
| Scope | The set of user claims to be requested from the IdP. |
| SessionCookieName | The name of the cookie used to maintain session information. |
| SessionTimeout | The maximum duration of the authentication session. |
| TokenEndpoint | The token endpoint of the IdP. |
| UserInfoEndpoint | The user info endpoint of the IdP. |
Properties
AuthenticationRequestExtraParams
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
virtual IDictionary<string, string> AuthenticationRequestExtraParams { get; }Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: - No extra parameters
AuthorizationEndpoint
The authorization endpoint of the IdP.
string AuthorizationEndpoint { get; }Property Value
System.String
Remarks
This must be a full URL, including the HTTPS protocol, the domain, and the path.
ClientId
The OAuth 2.0 client identifier.
string ClientId { get; }Property Value
System.String
ClientSecret
Issuer
The OIDC issuer identifier of the IdP.
string Issuer { get; }Property Value
System.String
Remarks
This must be a full URL, including the HTTPS protocol, the domain, and the path.
Next
OnUnauthenticatedRequest
The behavior if the user is not authenticated.
virtual Nullable<UnauthenticatedAction> OnUnauthenticatedRequest { get; }Property Value
System.Nullable<UnauthenticatedAction>
Remarks
Default: UnauthenticatedAction.AUTHENTICATE
Scope
The set of user claims to be requested from the IdP.
virtual string Scope { get; }Property Value
System.String
Remarks
To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.
Default: "openid"
SessionCookieName
The name of the cookie used to maintain session information.
virtual string SessionCookieName { get; }Property Value
System.String
Remarks
Default: "AWSELBAuthSessionCookie"
SessionTimeout
The maximum duration of the authentication session.
virtual Duration SessionTimeout { get; }Property Value
Remarks
Default: Duration.days(7)
TokenEndpoint
The token endpoint of the IdP.
string TokenEndpoint { get; }Property Value
System.String
Remarks
This must be a full URL, including the HTTPS protocol, the domain, and the path.
UserInfoEndpoint
The user info endpoint of the IdP.
string UserInfoEndpoint { get; }Property Value
System.String
Remarks
This must be a full URL, including the HTTPS protocol, the domain, and the path.