Struct AuthenticateOidcActionConfig

#[non_exhaustive]
pub struct AuthenticateOidcActionConfig {
    pub issuer: Option<String>,
    pub authorization_endpoint: Option<String>,
    pub token_endpoint: Option<String>,
    pub user_info_endpoint: Option<String>,
    pub client_id: Option<String>,
    pub client_secret: Option<String>,
    pub session_cookie_name: Option<String>,
    pub scope: Option<String>,
    pub session_timeout: Option<i64>,
    pub authentication_request_extra_params: Option<HashMap<String, String>>,
    pub on_unauthenticated_request: Option<AuthenticateOidcActionConditionalBehaviorEnum>,
    pub use_existing_client_secret: Option<bool>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

issuer: Option<String>

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

authorization_endpoint: Option<String>

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

token_endpoint: Option<String>

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

user_info_endpoint: Option<String>

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

client_id: Option<String>

The OAuth 2.0 client identifier.

client_secret: Option<String>

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.

session_cookie_name: Option<String>

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

scope: Option<String>

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.

session_timeout: Option<i64>

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

authentication_request_extra_params: Option<HashMap<String, String>>

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

on_unauthenticated_request: Option<AuthenticateOidcActionConditionalBehaviorEnum>

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.

use_existing_client_secret: Option<bool>

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.

Implementations

impl AuthenticateOidcActionConfig

pub fn issuer(&self) -> Option<&str>

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

pub fn authorization_endpoint(&self) -> Option<&str>

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

pub fn token_endpoint(&self) -> Option<&str>

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

pub fn user_info_endpoint(&self) -> Option<&str>

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

pub fn client_id(&self) -> Option<&str>

The OAuth 2.0 client identifier.

pub fn client_secret(&self) -> Option<&str>

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.

pub fn session_cookie_name(&self) -> Option<&str>

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

pub fn scope(&self) -> Option<&str>

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.

pub fn session_timeout(&self) -> Option<i64>

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

pub fn authentication_request_extra_params( &self, ) -> Option<&HashMap<String, String>>

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

pub fn on_unauthenticated_request( &self, ) -> Option<&AuthenticateOidcActionConditionalBehaviorEnum>

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.

pub fn use_existing_client_secret(&self) -> Option<bool>

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.

impl AuthenticateOidcActionConfig

pub fn builder() -> AuthenticateOidcActionConfigBuilder

Creates a new builder-style object to manufacture AuthenticateOidcActionConfig.

Trait Implementations

impl Clone for AuthenticateOidcActionConfig

fn clone(&self) -> AuthenticateOidcActionConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AuthenticateOidcActionConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AuthenticateOidcActionConfig

fn eq(&self, other: &AuthenticateOidcActionConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AuthenticateOidcActionConfig