AWS CloudFormation
User Guide (API Version 2010-05-15)

Elastic Load Balancing V2 AuthenticateOidcConfig

The AuthenticateOidcConfig property type specifies request parameters when using an identity provider (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.

AuthenticateOidcConfig is a property of the Elastic Load Balancing V2 Action property type.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "AuthenticationRequestExtraParams" : { String:String, ... } , "AuthorizationEndpoint" : String, "ClientId" : String, "ClientSecret" : String, "Issuer" : String, "OnUnauthenticatedRequest" : String, "Scope" : String, "SessionCookieName" : String, "SessionTimeout" : Number, "TokenEndpoint" : String, "UserInfoEndpoint" : String }

YAML

AuthenticationRequestExtraParams: { String:String, ... } AuthorizationEndpoint: String ClientId: String ClientSecret: String Issuer: String OnUnauthenticatedRequest: String Scope: String SessionCookieName: String SessionTimeout: Number TokenEndpoint: String UserInfoEndpoint: String

Properties

AuthenticationRequestExtraParams

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

Required: No

Type: Map of string-to-string values

Update requires: No interruption

AuthorizationEndpoint

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

Required: Yes

Type: String

Update requires: No interruption

ClientId

The OAuth 2.0 client identifier.

Required: Yes

Type: String

Update requires: No interruption

ClientSecret

The OAuth 2.0 client secret.

Required: Yes

Type: String

Update requires: No interruption

Issuer

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

Required: Yes

Type: String

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

SessionCookieName

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

Required: No

Type: String

Update requires: No interruption

SessionTimeout

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

Required: No

Type: Number

Update requires: No interruption

TokenEndpoint

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

Required: Yes

Type: String

Update requires: No interruption

UserInfoEndpoint

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

Required: Yes

Type: String

Update requires: No interruption

See Also

On this page: