OAuth2LoginRequest class abstract

OAuth2LoginRequest

Properties:

  • challenge - ID is the identifier ("login challenge") of the login request. It is used to identify the session.
  • client
  • oidcContext
  • requestUrl - RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters.
  • requestedAccessTokenAudience
  • requestedScope
  • sessionId - SessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag) this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false) this will be a new random value. This value is used as the "sid" parameter in the ID Token and in OIDC Front-/Back- channel logout. It's value can generally be used to associate consecutive login requests by a certain user.
  • skip - Skip, if true, implies that the client has requested the same scopes from the same user previously. If true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL. This feature allows you to update / set session information.
  • subject - Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope requested by the OAuth 2.0 client. If this value is set and skip is true, you MUST include this subject type when accepting the login request, or the request will fail.
Annotations
  • @BuiltValue()

Constructors

OAuth2LoginRequest([void updates(dynamic b)])
factory

Properties

challenge → String
ID is the identifier ("login challenge") of the login request. It is used to identify the session.
no setter
client → OAuth2Client
no setter
hashCode → int
The hash code for this object.
no setterinherited
oidcContext → OAuth2ConsentRequestOpenIDConnectContext?
no setter
requestedAccessTokenAudience → BuiltList<String>
no setter
requestedScope → BuiltList<String>
no setter
requestUrl → String
RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sessionId → String?
SessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag) this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false) this will be a new random value. This value is used as the "sid" parameter in the ID Token and in OIDC Front-/Back- channel logout. It's value can generally be used to associate consecutive login requests by a certain user.
no setter
skip → bool
Skip, if true, implies that the client has requested the same scopes from the same user previously. If true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL. This feature allows you to update / set session information.
no setter
subject → String
Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope requested by the OAuth 2.0 client. If this value is set and skip is true, you MUST include this subject type when accepting the login request, or the request will fail.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(dynamic)) → OAuth2LoginRequest
Rebuilds the instance.
inherited
toBuilder() → dynamic
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<OAuth2LoginRequest>
no setter