AuthUI

public protocol AuthUI : AnyObject

Responsible for managing the authentication flow for browser based federated sign in.

  • Presents the sign in UI for federated sign in using an external identity provider.

    Declaration

    Swift

    func presentFederatedSignInUI(presentationAnchor: ASPresentationAnchor) async throws -> AuthenticationTokens

    Parameters

    presentationAnchor

    Window to act as the anchor for this UI.

    Return Value

    Authentication tokens.

  • Presents the sign out UI for federated sign in using an external identity provider.

    Declaration

    Swift

    func presentFederatedSignOutUI(presentationAnchor: ASPresentationAnchor) async throws

    Parameters

    presentationAnchor

    Window to act as the anchor for this UI.

  • Processes federated sign in redirect URL to obtain the authentication tokens required for API access..

    Declaration

    Swift

    func processFederatedSignInTokens(url: URL) -> Bool

    Parameters

    url

    Federated sign in URL passed into the app via URL scheme.

    Return Value

    Boolean indicating whether or not the FSSO token was processed successfully.

  • Resets any internal state.

    Declaration

    Swift

    func reset()