A newer version of this documentation is available.

View Latest

login(withRequest)

AppDelegate.reachfive().login(
    withRequest,
    usingModalAuthorizationFor,
    display
)

Description

Logs the user in using credentials stored in the keychain. The system displays all available credentials in a modal sheet. Credentials can be passwords and/or passkeys.

Usage

Start this request in response to a user interaction when the display is .Always or automatically and/or early in a view lifecycle (e.g., in viewDidAppear). Alternatively, start the request during the application launch when the display is .IfImmediatelyAvailableCredentials.

Examples

AppDelegate
    .reachfive()
    .login(withRequest: NativeLoginRequest(anchor: window), usingModalAuthorizationFor: [.Passkey], display: .IfImmediatelyAvailableCredentials)

    // get auth token on success
    .onSuccess { authToken in
    }
    // return ReachFive error on failure
    .onFailure { error in
    }

Parameters

Parameter Description

withRequest NativeLoginRequest

Object containing parameters to send along with the request.

Object parameters:

  • anchor: The view that the credential provider uses if it requires user interaction.

  • originWebAuthn: The origin of the webauthn call.

  • scopes: The scopes granted to the profile.

  • origin: The origin of the call. This helps categorize inbound traffic.

usingModalAuthorizationFor

The type of credential, passkey and/or password.

display

Choice of behaviour when there are no credentials available.

options

  • Always: If credentials are available, presents a modal sign-in sheet. If there are no locally saved credentials and the authorization is for .Passkey, the system presents a QR code to allow signing in with a passkey from a nearby device. If there are no locally saved credentials and the authorization is for .Password, no UI appears. You can start this request in response to a user interaction.

  • IfImmediatelyAvailableCredentials: If credentials are available, presents a modal sign-in sheet. If there are no locally saved credentials, no UI appears and the call ends in ReachFiveError.AuthCanceled. You can start a request automatically early in the view lifecycle (e.g., in viewDidAppear) or at app launch.

Response

Type: Future<AuthToken, ReachFiveError>

AuthToken

The authentication token.

idToken

The ID token JSON Web Token (JWT) that contains the profile’s information.

accessToken

The authorization credential JSON Web Token (JWT) used to access the ReachFive API.

refreshToken

The refresh token JSON Web Token (JWT) used to obtain new access tokens once they expire. This is only available when the offline_access scope is requested.

tokenType

The type of token. Always equal to Bearer.

expiresIn

The lifetime in seconds of the access token.

If expiresIn is less than or equal to 0, the AuthToken is expired.

user OpenIDUser

The user’s information contained in the ID token.

id string

The identifier of the user.

name string

The full name of the user in displayable form including all name parts, possibly including titles and suffixes, ordered according to the user’s locale and preferences.

preferredUsername string

The shorthand name by which the user wishes to be referred to.

givenName string

The given name or first name of the user.

familyName string

The surname or last name of the user.

middleName string

The middle name of the user.

nickname string

The casual name of the user that may or may not be the same as the givenName

picture string

The URL of the user’s profile picture.

website string

The URL of the user’s web page or blog.

email string

The user’s preferred e-mail address.

emailVerified boolean

True if the user’s e-mail address has been verified; otherwise false.

gender string

The user’s gender.

zoneinfo string

The string from zoneinfo time zone database representing the user’s time zone.

locale string

The user’s language code in lowercase and country code in uppercase, separated by a dash.

phoneNumber string

The user’s preferred telephone number.

phoneNumberVerified boolean

true if the user’s phone number has been verified; otherwise false.

address string

The user’s preferred postal address.

ReachFiveError

Based on the problem, the ReachFiveError will be:

  • RequestError(requestErrors: RequestErrors) if it’s a bad request error.

    error string

    The main error message.

    errorId string

    The identifier of the error.

    errorUserMsg string

    The user-friendly error message.

    This property is translated according to the user’s browser settings. Currently supported languages:
    Currently supported languages

    • ar - العربية Arabic

    • de - Deutsch German

    • en - English

    • es - Español Spanish

    • fr - Français French

    • hu - Magyar Hungarian

    • it - Italiano Italian

    • jp - 日本 Japanese

    • ko - 한국인 Korean

    • nl - Nederlands Dutch

    • pt - Portuguese

    • ru - Ру́сский Russian

    • sk - Slovenský Slovak

    • zh-CN - People’s Republic of China Simplified Chinese

    • zh-Hans - Simplified Chinese

    • zh-Hant - Traditional Chinese

    • zh-HK - Hong Kong Traditional Chinese

    • zh-MO - Macao Traditional Chinese

    • zh-SG - Singapore Simplified Chinese

    • zh-TW - Taiwan Traditional Chinese

    errorMessageKey string

    The error message key.

    errorDescription string

    The technical error message.

    errorDetails FieldError[]

    field string

    The field concerned by the error.

    message string

    The message error returned for the field.

    code string

    The code error returned for the field.

    • AuthFailure(reason: String) if the authentication has failed.

    • AuthCanceled if the authentication was cancelled.

    • TechnicalError(reason: String) if it’s an internal server error.