OidcUser class

A user is a verified JWT id_token, with an optional access_token.

Properties

aggregatedClaims → Map<String, dynamic>
Combines claims from id_token and userinfo response.
final
allowedAlgorithms → List<String>?
The allowedAlgorithms that were passed from fromIdToken (if any).
final
attributes → Map<String, dynamic>
immutable custom attributes that are user-defined.
final
claims → JsonWebTokenClaims
The claims that were decoded from the idToken
no setter
hashCode → int
The hash code for this object.
no setterinherited
idToken → String
The jwt token this user was verified from.
final
keystore → JsonWebKeyStore?
The keystore that was passed from fromIdToken (if any).
final
parsedIdToken → JsonWebToken
The parsed jwt token
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
token → OidcToken
The current token the user is holding.
final
uid → String?
The user Id
no setter
uidRequired → String
The user Id, but if it's null, it will throw.
no setter
userInfo → Map<String, dynamic>
The userInfo response.
final

Methods

clearAttributes() → OidcUser
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
replaceToken(OidcToken newToken, {String? idTokenOverride, bool strictVerification = false, OidcStore? cacheStore}) → Future<OidcUser>
if an id_token exists in the newToken, it will be re-verified.
setAttributes(Map<String, dynamic> attributes) → OidcUser
toString() → String
A string representation of this object.
inherited
withUserInfo(Map<String, dynamic> userInfo) → OidcUser

Operators

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

Static Methods

fromIdToken({required OidcToken token, bool strictVerification = false, JsonWebKeyStore? keystore, OidcStore? cacheStore, List<String>? allowedAlgorithms, Map<String, dynamic>? attributes, Map<String, dynamic>? userInfo, String? idTokenOverride}) → Future<OidcUser>
Creates a OidcUser from an encoded id_token passed via token.