AuthCategory
public final class AuthCategory : Category
extension AuthCategory: AuthCategoryBehavior
extension AuthCategory: AuthCategoryDeviceBehavior
extension AuthCategory: AuthCategoryUserBehavior
extension AuthCategory: AuthCategoryWebAuthnBehaviour
extension AuthCategory: DefaultLogger
extension AuthCategory: Resettable
-
Declaration
Swift
public let categoryType: CategoryType
-
Adds
pluginto the list of Plugins that implement functionality for this category.Declaration
Swift
public func add(plugin: AuthCategoryPlugin) throwsParameters
pluginThe Plugin to add
-
Returns the added plugin with the specified
keyproperty.Declaration
Swift
public func getPlugin(for key: PluginKey) throws -> AuthCategoryPluginParameters
keyThe PluginKey (String) of the plugin to retrieve
Return Value
The wrapped plugin
-
Removes the plugin registered for
keyfrom the list of Plugins that implement functionality for this category. If no plugin has been added forkey, no action is taken, making this method safe to call multiple times.Declaration
Swift
public func removePlugin(for key: PluginKey)Parameters
keyThe key used to
addthe plugin -
signUp(username:Asynchronouspassword: options: ) Declaration
Swift
public func signUp( username: String, password: String? = nil, options: AuthSignUpRequest.Options? = nil ) async throws -> AuthSignUpResult -
confirmSignUp(for:AsynchronousconfirmationCode: options: ) Declaration
Swift
public func confirmSignUp( for username: String, confirmationCode: String, options: AuthConfirmSignUpRequest.Options? = nil ) async throws -> AuthSignUpResult -
resendSignUpCode(for:Asynchronousoptions: ) Declaration
Swift
public func resendSignUpCode( for username: String, options: AuthResendSignUpCodeRequest.Options? = nil ) async throws -> AuthCodeDeliveryDetails -
signIn(username:Asynchronouspassword: options: ) Declaration
Swift
public func signIn( username: String? = nil, password: String? = nil, options: AuthSignInRequest.Options? = nil ) async throws -> AuthSignInResult -
signInWithWebUI(presentationAnchor:Asynchronousoptions: ) Declaration
Swift
public func signInWithWebUI( presentationAnchor: AuthUIPresentationAnchor? = nil, options: AuthWebUISignInRequest.Options? = nil ) async throws -> AuthSignInResult -
signInWithWebUI(for:AsynchronouspresentationAnchor: options: ) Declaration
Swift
public func signInWithWebUI( for authProvider: AuthProvider, presentationAnchor: AuthUIPresentationAnchor? = nil, options: AuthWebUISignInRequest.Options? = nil ) async throws -> AuthSignInResult -
confirmSignIn(challengeResponse:Asynchronousoptions: ) Declaration
Swift
public func confirmSignIn( challengeResponse: String, options: AuthConfirmSignInRequest.Options? = nil ) async throws -> AuthSignInResult -
signOut(options:Asynchronous) Declaration
Swift
public func signOut(options: AuthSignOutRequest.Options? = nil) async -> AuthSignOutResult -
autoSignIn()AsynchronousDeclaration
Swift
public func autoSignIn() async throws -> AuthSignInResult -
deleteUser()AsynchronousDeclaration
Swift
public func deleteUser() async throws -
fetchAuthSession(options:Asynchronous) Declaration
Swift
public func fetchAuthSession(options: AuthFetchSessionRequest.Options? = nil) async throws -> AuthSession -
resetPassword(for:Asynchronousoptions: ) Declaration
Swift
public func resetPassword( for username: String, options: AuthResetPasswordRequest.Options? = nil ) async throws -> AuthResetPasswordResult -
Declaration
Swift
public func confirmResetPassword( for username: String, with newPassword: String, confirmationCode: String, options: AuthConfirmResetPasswordRequest.Options? = nil ) async throws -
setUpTOTP()AsynchronousDeclaration
Swift
public func setUpTOTP() async throws -> TOTPSetupDetails -
verifyTOTPSetup(code:Asynchronousoptions: ) Declaration
Swift
public func verifyTOTPSetup( code: String, options: VerifyTOTPSetupRequest.Options? = nil ) async throws -
fetchDevices(options:Asynchronous) Declaration
Swift
public func fetchDevices( options: AuthFetchDevicesRequest.Options? = nil ) async throws -> [AuthDevice] -
forgetDevice(_:Asynchronousoptions: ) Declaration
Swift
public func forgetDevice( _ device: AuthDevice? = nil, options: AuthForgetDeviceRequest.Options? = nil ) async throws -
rememberDevice(options:Asynchronous) Declaration
Swift
public func rememberDevice(options: AuthRememberDeviceRequest.Options? = nil) async throws -
getCurrentUser()AsynchronousRetrieve the current logged in user
Declaration
Swift
public func getCurrentUser() async throws -> any AuthUserReturn Value
Current logged in user
-
fetchUserAttributes(options:Asynchronous) Declaration
Swift
public func fetchUserAttributes( options: AuthFetchUserAttributesRequest.Options? = nil ) async throws -> [AuthUserAttribute] -
update(userAttribute:Asynchronousoptions: ) Declaration
Swift
public func update( userAttribute: AuthUserAttribute, options: AuthUpdateUserAttributeRequest.Options? = nil ) async throws -> AuthUpdateAttributeResult -
update(userAttributes:Asynchronousoptions: ) Declaration
Swift
public func update( userAttributes: [AuthUserAttribute], options: AuthUpdateUserAttributesRequest.Options? = nil ) async throws -> [AuthUserAttributeKey: AuthUpdateAttributeResult] -
resendConfirmationCode(forUserAttributeKey:Asynchronousoptions: ) Declaration
Swift
@available(*, deprecated, renamed: "sendVerificationCode(forUserAttributeKey:options:﹚") public func resendConfirmationCode( forUserAttributeKey userAttributeKey: AuthUserAttributeKey, options: AuthAttributeResendConfirmationCodeRequest.Options? = nil ) async throws -> AuthCodeDeliveryDetails -
sendVerificationCode(forUserAttributeKey:Asynchronousoptions: ) Declaration
Swift
public func sendVerificationCode( forUserAttributeKey userAttributeKey: AuthUserAttributeKey, options: AuthSendUserAttributeVerificationCodeRequest.Options? = nil ) async throws -> AuthCodeDeliveryDetails -
confirm(userAttribute:AsynchronousconfirmationCode: options: ) Declaration
Swift
public func confirm( userAttribute: AuthUserAttributeKey, confirmationCode: String, options: AuthConfirmUserAttributeRequest.Options? = nil ) async throws -
update(oldPassword:Asynchronousto: options: ) Declaration
Swift
public func update( oldPassword: String, to newPassword: String, options: AuthChangePasswordRequest.Options? = nil ) async throws -
Declaration
Swift
@available(iOS 17.4, macOS 13.5, *) public func associateWebAuthnCredential( presentationAnchor: AuthUIPresentationAnchor? = nil, options: AuthAssociateWebAuthnCredentialRequest.Options? = nil ) async throws -
-
listWebAuthnCredentials(options:Asynchronous) Declaration
Swift
public func listWebAuthnCredentials( options: AuthListWebAuthnCredentialsRequest.Options? = nil ) async throws -> AuthListWebAuthnCredentialsResult -
deleteWebAuthnCredential(credentialId:Asynchronousoptions: ) Declaration
Swift
public func deleteWebAuthnCredential( credentialId: String, options: AuthDeleteWebAuthnCredentialRequest.Options? = nil ) async throws -
Declaration
Swift
public static var log: Logger { get } -
Declaration
Swift
public var log: Logger { get } -
reset()AsynchronousDeclaration
Swift
public func reset() async
View on GitHub