AuthRequest class
Used to configure an authentication request.
Note: In msal.js, this is called AuthenticationParameters
.
Constructors
Properties
- account ↔ Account
-
Set to provide a hint to the authorization endpoint about the
specific user to get a token for.
read / write
-
Set to override the authority used for this request.
read / write
-
Sets the OpenID configuration metadata for the configured authority.
read / write
- claimsRequest ↔ String
-
Sets additional claims to be requested.
read / write
- correlationId ↔ String
-
Sets a unique identifier that can be used to map requests and responses.
read / write
-
extraQueryParameters
↔ Map<
String, String> -
Sets additional query parameters to attach to the HTTP request.
read / write
-
extraScopesToConsent
↔ List<
String> -
Sets the additional scopes the user must consent to, usually for a different
resource than the normal request scopes.
read / write
- forceRefresh ↔ bool
-
Sets whether the cache should be skipped and a token request to the
authorization server should be made.
read / write
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- loginHint ↔ String
-
Sets a hint to bypass the account selection prompt. Should be set to
the ID token's
preferred_username
claim.read / write -
Sets the callback that will be invoked before a redirect flow (e.g.
loginRedirect
,acquireTokenRedirect
) navigates to a URL.read / write - prompt ↔ String
-
Set to control the interactivity with the user during authentication.
read / write
- redirectStartPage ↔ String
-
Sets the page that should be returned to after
loginRedirect
oracquireTokenRedirect
.read / write - redirectUri ↔ String
-
Set to override the redirect URI used when retrieving a token.
read / write
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
-
scopes
↔ List<
String> -
Sets the scopes, which the user will need to consent to, for gaining
permission to access specific parts of a resource protected by scopes.
read / write
- sid ↔ String
-
Sets the session ID claim which allows the application to identify the
user's Azure AD session independent of the user's account name or username
and bypass the account selection prompt.
read / write
- state ↔ String
-
Sets the OAuth 2.0 state which will be returned in the auth response.
read / write
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toString(
) → String -
A string representation of this object. [...]
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited