Class CfnListener.AuthenticateOidcConfigProperty

Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.

Inheritance

object

CfnListener.AuthenticateOidcConfigProperty

Implements

CfnListener.IAuthenticateOidcConfigProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.ElasticLoadBalancingV2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnListener.AuthenticateOidcConfigProperty : CfnListener.IAuthenticateOidcConfigProperty

Syntax (vb)

Public Class CfnListener.AuthenticateOidcConfigProperty Implements CfnListener.IAuthenticateOidcConfigProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ElasticLoadBalancingV2;

             var authenticateOidcConfigProperty = new AuthenticateOidcConfigProperty {
                 AuthorizationEndpoint = "authorizationEndpoint",
                 ClientId = "clientId",
                 Issuer = "issuer",
                 TokenEndpoint = "tokenEndpoint",
                 UserInfoEndpoint = "userInfoEndpoint",

                 // the properties below are optional
                 AuthenticationRequestExtraParams = new Dictionary<string, string> {
                     { "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams" }
                 },
                 ClientSecret = "clientSecret",
                 OnUnauthenticatedRequest = "onUnauthenticatedRequest",
                 Scope = "scope",
                 SessionCookieName = "sessionCookieName",
                 SessionTimeout = "sessionTimeout",
                 UseExistingClientSecret = false
             };

Synopsis

Constructors

AuthenticateOidcConfigProperty()

Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.

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. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set `UseExistingClientSecret` to true.
Issuer	The OIDC issuer identifier of the IdP.
OnUnauthenticatedRequest	The behavior if the user is not authenticated. The following are possible values:.
Scope	The set of user claims to be requested from the IdP. The default is `openid` .
SessionCookieName	The name of the cookie used to maintain session information.
SessionTimeout	The maximum duration of the authentication session, in seconds.
TokenEndpoint	The token endpoint of the IdP.
UseExistingClientSecret	Indicates whether to use the existing client secret when modifying a rule.
UserInfoEndpoint	The user info endpoint of the IdP.

Constructors

AuthenticateOidcConfigProperty()

Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.

public AuthenticateOidcConfigProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ElasticLoadBalancingV2;

             var authenticateOidcConfigProperty = new AuthenticateOidcConfigProperty {
                 AuthorizationEndpoint = "authorizationEndpoint",
                 ClientId = "clientId",
                 Issuer = "issuer",
                 TokenEndpoint = "tokenEndpoint",
                 UserInfoEndpoint = "userInfoEndpoint",

                 // the properties below are optional
                 AuthenticationRequestExtraParams = new Dictionary<string, string> {
                     { "authenticationRequestExtraParamsKey", "authenticationRequestExtraParams" }
                 },
                 ClientSecret = "clientSecret",
                 OnUnauthenticatedRequest = "onUnauthenticatedRequest",
                 Scope = "scope",
                 SessionCookieName = "sessionCookieName",
                 SessionTimeout = "sessionTimeout",
                 UseExistingClientSecret = false
             };

Properties

AuthenticationRequestExtraParams

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

public object? AuthenticationRequestExtraParams { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticloadbalancingv2-listener-authenticateoidcconfig.html#cfn-elasticloadbalancingv2-listener-authenticateoidcconfig-authenticationrequestextraparams

AuthorizationEndpoint

The authorization endpoint of the IdP.

public string AuthorizationEndpoint { get; set; }

Property Value

string

Remarks

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

ClientId

The OAuth 2.0 client identifier.

public string ClientId { get; set; }

Property Value

string

Remarks

ClientSecret

The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.

public string? ClientSecret { get; set; }

Property Value

string

Remarks

Issuer

The OIDC issuer identifier of the IdP.

public string Issuer { get; set; }

Property Value

string

Remarks

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

OnUnauthenticatedRequest

The behavior if the user is not authenticated. The following are possible values:.

public string? OnUnauthenticatedRequest { get; set; }

Property Value

string

Remarks

Scope

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

public string? Scope { get; set; }

Property Value

string

Remarks

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

SessionCookieName

The name of the cookie used to maintain session information.

public string? SessionCookieName { get; set; }

Property Value

string

Remarks

The default is AWSELBAuthSessionCookie.

SessionTimeout

The maximum duration of the authentication session, in seconds.

public string? SessionTimeout { get; set; }

Property Value

string

Remarks

The default is 604800 seconds (7 days).

TokenEndpoint

The token endpoint of the IdP.

public string TokenEndpoint { get; set; }

Property Value

string

Remarks

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

UseExistingClientSecret

Indicates whether to use the existing client secret when modifying a rule.

public object? UseExistingClientSecret { get; set; }

Property Value

object

Remarks

If you are creating a rule, you can omit this parameter or set it to false.

UserInfoEndpoint

The user info endpoint of the IdP.

public string UserInfoEndpoint { get; set; }

Property Value

string

Remarks

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

Implements

CfnListener.IAuthenticateOidcConfigProperty