AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Request parameters when using an identity provider (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.

Inheritance Hierarchy

System.Object
  Amazon.ElasticLoadBalancingV2.Model.AuthenticateOidcActionConfig

Namespace: Amazon.ElasticLoadBalancingV2.Model
Assembly: AWSSDK.ElasticLoadBalancingV2.dll
Version: 3.x.y.z

Syntax

C#
public class AuthenticateOidcActionConfig

The AuthenticateOidcActionConfig type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AuthenticationRequestExtraParams System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property AuthenticationRequestExtraParams.

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

Public Property AuthorizationEndpoint System.String

Gets and sets the property AuthorizationEndpoint.

The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

Public Property ClientId System.String

Gets and sets the property ClientId.

The OAuth 2.0 client identifier.

Public Property ClientSecret System.String

Gets and sets the property 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 Property Issuer System.String

Gets and sets the property Issuer.

The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

Public Property OnUnauthenticatedRequest Amazon.ElasticLoadBalancingV2.AuthenticateOidcActionConditionalBehaviorEnum

Gets and sets the property OnUnauthenticatedRequest.

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

  • deny - Return an HTTP 401 Unauthorized error.

  • allow - Allow the request to be forwarded to the target.

  • authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

Public Property Scope System.String

Gets and sets the property Scope.

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

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

Public Property SessionCookieName System.String

Gets and sets the property SessionCookieName.

The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

Public Property SessionTimeout System.Int64

Gets and sets the property SessionTimeout.

The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

Public Property TokenEndpoint System.String

Gets and sets the property TokenEndpoint.

The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

Public Property UseExistingClientSecret System.Boolean

Gets and sets the property UseExistingClientSecret.

Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.

Public Property UserInfoEndpoint System.String

Gets and sets the property UserInfoEndpoint.

The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5