AuthenticateOidcActionConfig ¶

class AuthenticateOidcActionConfig(TypedDict, closed=True):
    issuer: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_oidc_action_issuer.AuthenticateOidcActionIssuer"
    ]
    """<p>The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.</p>"""
    authorization_endpoint: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_oidc_action_authorization_endpoint.AuthenticateOidcActionAuthorizationEndpoint"
    ]
    """<p>The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.</p>"""
    token_endpoint: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_oidc_action_token_endpoint.AuthenticateOidcActionTokenEndpoint"
    ]
    """<p>The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.</p>"""
    user_info_endpoint: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_oidc_action_user_info_endpoint.AuthenticateOidcActionUserInfoEndpoint"
    ]
    """<p>The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.</p>"""
    client_id: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_oidc_action_client_id.AuthenticateOidcActionClientId"
    ]
    """<p>The OAuth 2.0 client identifier.</p>"""
    client_secret: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_oidc_action_client_secret.AuthenticateOidcActionClientSecret"
    ]
    """<p>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 <code>UseExistingClientSecret</code> to true.</p>"""
    session_cookie_name: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_oidc_action_session_cookie_name.AuthenticateOidcActionSessionCookieName"
    ]
    """<p>The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.</p>"""
    scope: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_oidc_action_scope.AuthenticateOidcActionScope"
    ]
    """<p>The set of user claims to be requested from the IdP. The default is <code>openid</code>.</p> <p>To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.</p>"""
    session_timeout: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_oidc_action_session_timeout.AuthenticateOidcActionSessionTimeout"
    ]
    """<p>The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).</p>"""
    authentication_request_extra_params: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_oidc_action_authentication_request_extra_params.AuthenticateOidcActionAuthenticationRequestExtraParams"
    ]
    """<p>The query parameters (up to 10) to include in the redirect request to the authorization endpoint.</p>"""
    on_unauthenticated_request: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_oidc_action_conditional_behavior_enum.AuthenticateOidcActionConditionalBehaviorEnum"
    ]
    """<p>The behavior if the user is not authenticated. The following are possible values:</p> <ul> <li> <p>deny<code></code> - Return an HTTP 401 Unauthorized error.</p> </li> <li> <p>allow<code></code> - Allow the request to be forwarded to the target.</p> </li> <li> <p>authenticate<code></code> - Redirect the request to the IdP authorization endpoint. This is the default value.</p> </li> </ul>"""
    use_existing_client_secret: NotRequired[
        "capo_elastic_load_balancing_v2.types.authenticate_oidc_action_use_existing_client_secret.AuthenticateOidcActionUseExistingClientSecret"
    ]
    """<p>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.</p>"""