AWS::ElasticLoadBalancingV2::ListenerRule AuthenticateOidcConfig - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::ElasticLoadBalancingV2::ListenerRule AuthenticateOidcConfig

指定使用符合 OpenID Connect (OIDC) 的身份提供商 (IdP) 对用户进行身份验证时所需的信息。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

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

属性

AuthenticationRequestExtraParams

要在重定向到授权终端节点的请求中包含的查询参数(最多 10 个)。

必需:否

类型:字符串的映射

Update requires: No interruption

AuthorizationEndpoint

IdP 的授权终端节点。这必须是一个完整 URL,包括 HTTPS 协议、域和路径。

必需:是

类型:字符串

Update requires: No interruption

ClientId

OAuth 2.0 客户端标识符。

必需:是

类型:字符串

Update requires: No interruption

ClientSecret

OAuth 2.0 客户端密钥。创建规则时需要此参数。如果您正在修改规则,并且将 UseExistingClientSecret 设置为 True,则可省略此参数。

必需:是

类型:字符串

Update requires: No interruption

Issuer

IdP 的 OIDC 发布者标识符。这必须是一个完整 URL,包括 HTTPS 协议、域和路径。

必需:是

类型:字符串

Update requires: No interruption

OnUnauthenticatedRequest

未对用户进行身份验证时的行为。以下是可能的值:

  • deny - 返回“HTTP 401 未授权”错误。

  • allow - 允许将请求转发到目标。

  • authenticate - 将请求重定向到 IdP 授权终端节点。这是默认值。

必需:否

类型:字符串

允许的值allow | authenticate | deny

Update requires: No interruption

Scope

从 IdP 中请求的一组用户声明。默认为 openid

要验证您的 IdP 支持的范围值以及如何分隔多个值,请参阅您的 IdP 文档。

必需:否

类型:字符串

Update requires: No interruption

SessionCookieName

用于保留会话信息的 Cookie 的名称。默认值为 AWSELBAuthSessionCookie。

必需:否

类型:字符串

Update requires: No interruption

SessionTimeout

身份验证会话的最大持续时间(以秒为单位)。默认值为 604800 秒(7 天)。

必需:否

类型:长整型

Update requires: No interruption

TokenEndpoint

IdP 的令牌终端节点。这必须是一个完整 URL,包括 HTTPS 协议、域和路径。

必需:是

类型:字符串

Update requires: No interruption

UserInfoEndpoint

IdP 的用户信息终端节点。这必须是一个完整 URL,包括 HTTPS 协议、域和路径。

必需:是

类型:字符串

Update requires: No interruption