AuthenticateOidcActionConfig class

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

Constructors

AuthenticateOidcActionConfig({required String authorizationEndpoint, required String clientId, required String issuer, required String tokenEndpoint, required String userInfoEndpoint, Map<String, String>? authenticationRequestExtraParams, String? clientSecret, AuthenticateOidcActionConditionalBehaviorEnum? onUnauthenticatedRequest, String? scope, String? sessionCookieName, int? sessionTimeout, bool? useExistingClientSecret})

AuthenticateOidcActionConfig.fromXml(XmlElement elem)

factory

Properties

authenticationRequestExtraParams → Map<String, String>?

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

final

authorizationEndpoint → String

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

final

clientId → String

The OAuth 2.0 client identifier.

final

clientSecret → 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.

final

hashCode → int

The hash code for this object.

no setter, inherited

issuer → String

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

final

onUnauthenticatedRequest → AuthenticateOidcActionConditionalBehaviorEnum?

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

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scope → String?

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

final

sessionCookieName → String?

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

final

sessionTimeout → int?

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

final

tokenEndpoint → String

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

final

useExistingClientSecret → 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.

final

userInfoEndpoint → String

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

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited