AuthOptions class

Configures the SDK's built-in authentication endpoints and token mapping.

Provide this to SdkConfig.auth when you want to use Sdk.instance.auth for login and refresh flows. Token paths are resolved against the successful response payload returned by the configured contract.

Constructors

AuthOptions.new({required String loginEndpoint, required String refreshEndpoint, required String accessTokenPath, required String refreshTokenPath, String refreshRequestKey = 'refreshToken'})
Creates authentication settings for login and refresh.
const

Properties

accessTokenPath → String
Dot-separated path to the access token inside successful response data.
final
hashCode → int
The hash code for this object.
no setterinherited
loginEndpoint → String
The endpoint used by the built-in login helper.
final
refreshEndpoint → String
The endpoint used by the built-in refresh helper.
final
refreshRequestKey → String
The request body key used when sending the refresh token.
final
refreshTokenPath → String
Dot-separated path to the refresh token inside successful response data.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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