AuthCategory

public final class AuthCategory : Category, @unchecked Sendable

extension AuthCategory: AuthCategoryBehavior

extension AuthCategory: AuthCategoryDeviceBehavior

extension AuthCategory: AuthCategoryUserBehavior

extension AuthCategory: AuthCategoryWebAuthnBehaviour

extension AuthCategory: DefaultLogger

extension AuthCategory: Resettable

Note

@unchecked Sendable to satisfy the Sendable requirement that the category behavior protocol now carries.

Unchecked in the literal sense: plugins and isConfigured are plain mutable state with no lock. add(plugin:) cannot race a configured category — it throws once isConfigured is set — but removePlugin(for:) mutates plugins with no such guard and no lock, so it can race a concurrent read. That exposure predates this annotation; the annotation only stops the compiler from asking about it.

categoryType
Declaration
Swift

public let categoryType: CategoryType

Plugin handling


                    
                    
                    add(plugin:)

Adds plugin to the list of Plugins that implement functionality for this category.

Declaration

Swift

public func add(plugin: AuthCategoryPlugin) throws

Parameters


                                plugin

The Plugin to add


                    
                    
                    getPlugin(for:)

Returns the added plugin with the specified key property.

Declaration

Swift

public func getPlugin(for key: PluginKey) throws -> AuthCategoryPlugin

Parameters

key

The PluginKey (String) of the plugin to retrieve

Return Value

The wrapped plugin


                    
                    
                    removePlugin(for:)

Removes the plugin registered for key from the list of Plugins that implement functionality for this category. If no plugin has been added for key, no action is taken, making this method safe to call multiple times.

Declaration

Swift

public func removePlugin(for key: PluginKey)

Parameters

key

The key used to add the plugin


                    
                    
                    signUp(username:password:options:)

Asynchronous

Declaration

Swift

public func signUp(
    username: String,
    password: String? = nil,
    options: AuthSignUpRequest.Options? = nil
) async throws -> AuthSignUpResult


                    
                    
                    confirmSignUp(for:confirmationCode:options:)

Asynchronous

Declaration

Swift

public func confirmSignUp(
    for username: String,
    confirmationCode: String,
    options: AuthConfirmSignUpRequest.Options? = nil
) async throws -> AuthSignUpResult


                    
                    
                    resendSignUpCode(for:options:)

Asynchronous

Declaration

Swift

public func resendSignUpCode(
    for username: String,
    options: AuthResendSignUpCodeRequest.Options? = nil
) async throws -> AuthCodeDeliveryDetails


                    
                    
                    signIn(username:password:options:)

Asynchronous

Declaration

Swift

public func signIn(
    username: String? = nil,
    password: String? = nil,
    options: AuthSignInRequest.Options? = nil
) async throws -> AuthSignInResult


                    
                    
                    signInWithWebUI(presentationAnchor:options:)

Asynchronous

Declaration

Swift

public func signInWithWebUI(
    presentationAnchor: AuthUIPresentationAnchor? = nil,
    options: AuthWebUISignInRequest.Options? = nil
) async throws -> AuthSignInResult


                    
                    
                    signInWithWebUI(for:presentationAnchor:options:)

Asynchronous

Declaration

Swift

public func signInWithWebUI(
    for authProvider: AuthProvider,
    presentationAnchor: AuthUIPresentationAnchor? = nil,
    options: AuthWebUISignInRequest.Options? = nil
) async throws -> AuthSignInResult


                    
                    
                    confirmSignIn(challengeResponse:options:)

Asynchronous

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()

Asynchronous

Declaration

Swift

public func autoSignIn() async throws -> AuthSignInResult

deleteUser() Asynchronous
Declaration
Swift

public func deleteUser() async throws


                    
                    
                    fetchAuthSession(options:)

Asynchronous

Declaration

Swift

public func fetchAuthSession(options: AuthFetchSessionRequest.Options? = nil) async throws -> AuthSession


                    
                    
                    resetPassword(for:options:)

Asynchronous

Declaration

Swift

public func resetPassword(
    for username: String,
    options: AuthResetPasswordRequest.Options? = nil
) async throws -> AuthResetPasswordResult


                    
                    
                    confirmResetPassword(for:with:confirmationCode:options:)

Asynchronous

Declaration

Swift

public func confirmResetPassword(
    for username: String,
    with newPassword: String,
    confirmationCode: String,
    options: AuthConfirmResetPasswordRequest.Options? = nil
) async throws


                    
                    
                    setUpTOTP()

Asynchronous

Declaration

Swift

public func setUpTOTP() async throws -> TOTPSetupDetails


                    
                    
                    verifyTOTPSetup(code:options:)

Asynchronous

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(_:options:)

Asynchronous

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() Asynchronous
Retrieve the current logged in user
Declaration
Swift

public func getCurrentUser() async throws -> any AuthUser
Return Value

Current logged in user


                    
                    
                    fetchUserAttributes(options:)

Asynchronous

Declaration

Swift

public func fetchUserAttributes(
    options: AuthFetchUserAttributesRequest.Options? = nil
) async throws -> [AuthUserAttribute]


                    
                    
                    update(userAttribute:options:)

Asynchronous

Declaration

Swift

public func update(
    userAttribute: AuthUserAttribute,
    options: AuthUpdateUserAttributeRequest.Options? = nil
) async throws -> AuthUpdateAttributeResult


                    
                    
                    update(userAttributes:options:)

Asynchronous

Declaration

Swift

public func update(
    userAttributes: [AuthUserAttribute],
    options: AuthUpdateUserAttributesRequest.Options? = nil
)
    async throws -> [AuthUserAttributeKey: AuthUpdateAttributeResult]


                    
                    
                    resendConfirmationCode(forUserAttributeKey:options:)

Asynchronous

Declaration

Swift

@available(*, deprecated, renamed: "sendVerificationCode(forUserAttributeKey:options:﹚")
public func resendConfirmationCode(
    forUserAttributeKey userAttributeKey: AuthUserAttributeKey,
    options: AuthAttributeResendConfirmationCodeRequest.Options? = nil
) async throws -> AuthCodeDeliveryDetails


                    
                    
                    sendVerificationCode(forUserAttributeKey:options:)

Asynchronous

Declaration

Swift

public func sendVerificationCode(
    forUserAttributeKey userAttributeKey: AuthUserAttributeKey,
    options: AuthSendUserAttributeVerificationCodeRequest.Options? = nil
) async throws -> AuthCodeDeliveryDetails


                    
                    
                    confirm(userAttribute:confirmationCode:options:)

Asynchronous

Declaration

Swift

public func confirm(
    userAttribute: AuthUserAttributeKey,
    confirmationCode: String,
    options: AuthConfirmUserAttributeRequest.Options? = nil
) async throws


                    
                    
                    update(oldPassword:to:options:)

Asynchronous

Declaration

Swift

public func update(
    oldPassword: String,
    to newPassword: String,
    options: AuthChangePasswordRequest.Options? = nil
) async throws


                    
                    
                    associateWebAuthnCredential(presentationAnchor:options:)

Asynchronous

Declaration

Swift

@available(iOS 17.4, macOS 13.5, *)
public func associateWebAuthnCredential(
    presentationAnchor: AuthUIPresentationAnchor? = nil,
    options: AuthAssociateWebAuthnCredentialRequest.Options? = nil
) async throws

associateWebAuthnCredential(presentationAnchor:options:)


                    
                    
                    listWebAuthnCredentials(options:)

Asynchronous

Declaration

Swift

public func listWebAuthnCredentials(
    options: AuthListWebAuthnCredentialsRequest.Options? = nil
) async throws -> AuthListWebAuthnCredentialsResult


                    
                    
                    deleteWebAuthnCredential(credentialId:options:)

Asynchronous

Declaration

Swift

public func deleteWebAuthnCredential(
    credentialId: String,
    options: AuthDeleteWebAuthnCredentialRequest.Options? = nil
) async throws

log
Declaration
Swift

public static var log: Logger { get }
log
Declaration
Swift

public var log: Logger { get }
reset() Asynchronous
Declaration
Swift

public func reset() async