AppleIdp class
Main class for the Apple identity provider. The methods defined here are intended to be called from an endpoint.
The admin property provides access to AppleIdpAdmin, which contains
admin-related methods for managing Apple-backed accounts.
The utils property provides access to AppleIdpUtils, which contains
utility methods for working with Apple-backed accounts. These can be used
to implement custom authentication flows if needed.
If you would like to modify the authentication flow, consider creating custom implementations of the relevant methods.
Constructors
- AppleIdp(AppleIdpConfig config, {required TokenManager tokenManager, AuthUsers authUsers = const AuthUsers(), UserProfiles userProfiles = const UserProfiles()})
-
Creates a new instance of AppleIdp.
factory
Properties
- admin ↔ AppleIdpAdmin
-
Admin operations to work with Apple-backed accounts.
latefinal
- config → AppleIdpConfig
-
The configuration for the Apple identity provider.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- utils → AppleIdpUtils
-
Utility functions for the Apple identity provider.
final
Methods
-
login(
Session session, {required String identityToken, required String authorizationCode, required bool isNativeApplePlatformSignIn, String? firstName, String? lastName, Transaction? transaction}) → Future< AuthSuccess> - Signs in a user with their Apple account.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
revokedNotificationRoute(
) → Route - Route for handling revoking sessions based on server-to-server notifications coming from Apple.
-
toString(
) → String -
A string representation of this object.
inherited
-
webAuthenticationCallbackRoute(
) → Route - Route for handling callbacks during authentication with AppleIdp on foreign platforms such as Web, Android, etc, as opposed to iOS and macOS.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited