DefaultSudoUserClient

public class DefaultSudoUserClient : SudoUserClient

Default implementation for SudoUserClient.

Lifecycle


                    
                    
                    init(keyNamespace:logger:)

Intializes a new DefaultSudoUserClient instance. It uses configuration parameters defined in sudoplatformconfig.json file located in the app bundle.

Declaration

Swift

convenience public init(keyNamespace: String, logger: SudoLogging.Logger? = nil) throws

Parameters

`keyNamespace`	Namespace to use for the keys and passwords. This has to be unique per client per app to avoid different apps (with keychain sharing) or different clients creating conflicting keys.
`logger`	A logger to use for logging messages. If none provided then a default internal logger will be used.


                    
                    
                    init(config:keyNamespace:logger:)

Intializes a new DefaultSudoUserClient instance.

Declaration

Swift

public init(
    config: [String: Any],
    keyNamespace: String,
    logger: SudoLogging.Logger? = nil
) throws

Parameters

`config`	Configuration parameters for the client.
`keyNamespace`	Namespace to use for the keys and passwords.
`logger`	A logger to use for logging messages. If none provided then a default internal logger will be used.

Conformance: SudoUserClient

version
Declaration
Swift

public var version: String { get }


                    
                    
                    isRegistered()

Asynchronous

Declaration

Swift

public func isRegistered() async throws -> Bool

reset() Asynchronous
Declaration
Swift

public func reset() async throws


                    
                    
                    registerWithDeviceCheck(token:buildType:vendorId:registrationId:)

Asynchronous

Declaration

Swift

public func registerWithDeviceCheck(
    token: Data,
    buildType: String,
    vendorId: UUID,
    registrationId: String?
) async throws -> String


                    
                    
                    registerWithAuthenticationProvider(authenticationProvider:registrationId:)

Asynchronous

Declaration

Swift

public func registerWithAuthenticationProvider(
    authenticationProvider: AuthenticationProvider,
    registrationId: String?
) async throws -> String

deregister() Asynchronous
Declaration
Swift

public func deregister() async throws


                    
                    
                    resetUserData()

Asynchronous

Declaration

Swift

public func resetUserData() async throws


                    
                    
                    signInWithKey()

Asynchronous

Declaration

Swift

public func signInWithKey() async throws -> AuthenticationTokens


                    
                    
                    signInWithAuthenticationProvider(authenticationProvider:)

Asynchronous

Declaration

Swift

public func signInWithAuthenticationProvider(authenticationProvider: AuthenticationProvider) async throws -> AuthenticationTokens


                    
                    
                    presentFederatedSignInUI(presentationAnchor:preferPrivateSession:)

Asynchronous

Declaration

Swift

public func presentFederatedSignInUI(
    presentationAnchor: ASPresentationAnchor,
    preferPrivateSession: Bool
) async throws -> AuthenticationTokens


                    
                    
                    presentFederatedSignOutUI(presentationAnchor:)

Asynchronous

Declaration

Swift

public func presentFederatedSignOutUI(presentationAnchor: ASPresentationAnchor) async throws


                    
                    
                    refreshTokens()

Asynchronous

Declaration

Swift

public func refreshTokens() async throws -> AuthenticationTokens


                    
                    
                    getUserName()

Asynchronous

Declaration

Swift

public func getUserName() async throws -> String


                    
                    
                    getSubject()

Asynchronous

Declaration

Swift

public func getSubject() async throws -> String?


                    
                    
                    getIdToken()

Asynchronous

Declaration

Swift

public func getIdToken() async throws -> String


                    
                    
                    getAccessToken()

Asynchronous

Declaration

Swift

public func getAccessToken() async throws -> String


                    
                    
                    getRefreshToken()

Asynchronous

Declaration

Swift

public func getRefreshToken() async throws -> String


                    
                    
                    clearAuthTokens()

Asynchronous

Declaration

Swift

public func clearAuthTokens() async throws

signOut() Asynchronous
Declaration
Swift

public func signOut() async throws


                    
                    
                    globalSignOut()

Asynchronous

Declaration

Swift

public func globalSignOut() async throws


                    
                    
                    getIdentityId()

Asynchronous

Declaration

Swift

public func getIdentityId() async throws -> String


                    
                    
                    getUserClaim(name:)

Asynchronous

Declaration

Swift

public func getUserClaim(name: String) async throws -> Any?


                    
                    
                    isSignedIn()

Asynchronous

Declaration

Swift

public func isSignedIn() async throws -> Bool


                    
                    
                    registerSignInStatusObserver(id:observer:)

Asynchronous

Declaration

Swift

public func registerSignInStatusObserver(id: String, observer: SignInStatusObserver) async


                    
                    
                    deregisterSignInStatusObserver(id:)

Asynchronous

Declaration

Swift

public func deregisterSignInStatusObserver(id: String) async


                    
                    
                    getSupportedRegistrationChallengeType()

Declaration

Swift

public func getSupportedRegistrationChallengeType() -> [ChallengeType]