login(withNonDiscoverableUserName)
AppDelegate.reachfive().login( withNonDiscoverableUserName, forRequest, usingModalAuthorizationFor, display )
Description
Logs the user in using credentials stored in the keychain. The system only displays the credential associated with the given username in a modal sheet.
In this case, the user needs to manually enter the username in the username field. |
Usage
By default, you should use the login(withRequest) method.
Use this method only when heightened security is required or when the user has already supplied a username. |
Examples
AppDelegate
.reachfive()
.login(withNonDiscoverableUsername: .Unspecified(username), forRequest: NativeLoginRequest(anchor: window), usingModalAuthorizationFor: [.Passkey], display: .Always)
// get auth token on success
.onSuccess { authToken in
}
// return ReachFive error on failure
.onFailure { error in
}
Parameters
Parameter | Description |
---|---|
The username of the profile. |
|
Object containing parameters to send along with the request. Object parameters:
|
|
The type of credential, currently only passkey supported. |
|
Choice of behaviour when there are no credentials available. options
|
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 |
||||||||||||||||||||||||||||||||||
tokenType |
The type of token. Always equal to |
||||||||||||||||||||||||||||||||||
expiresIn |
The lifetime in seconds of the access token. If |
||||||||||||||||||||||||||||||||||
user OpenIDUser |
The user’s information contained in the ID token.
|
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.