signup(withRequest)

AppDelegate.reachfive().signup(
    withRequest
)

Description

Signs up a user using a passkey.

Usage

You should use this for users that don’t have accounts and want to sign up using the passkey option.

Examples

import Reach5

do {
    let authToken = try await AppDelegate.reachfive().signup(withRequest: PasskeySignupRequest(passkeyProfile: profile, friendlyName: username, presenting: presenting))
    // Get the profile's authentication token
} catch {
    // Return a ReachFive error
}

Parameters

Parameter Description

Parameter	Description
withRequest `PasskeySignupRequest`	Object containing parameters to send along with the request. Object parameters: `passkeyProfile`: The data of the profile. `friendlyName`: The name that is displayed by the system when presenting the passkey for login. `presenting`: Where the credential provider presents its UI, built with `Presentation(from: self)` from a view controller attached to a window (`viewDidAppear` or a user interaction, not `viewDidLoad`). `originWebAuthn`: The origin of the webauthn call. Defaults to the `originWebAuthn` of your `SdkConfig`, or to `https://${domain}`. `scopes`: The scopes granted to the profile. `origin`: The origin of the call. This helps categorize inbound traffic.

withRequest PasskeySignupRequest

Object containing parameters to send along with the request.

Object parameters:

passkeyProfile: The data of the profile.
friendlyName: The name that is displayed by the system when presenting the passkey for login.
presenting: Where the credential provider presents its UI, built with Presentation(from: self) from a view controller attached to a window (viewDidAppear or a user interaction, not viewDidLoad).
originWebAuthn: The origin of the webauthn call. Defaults to the originWebAuthn of your SdkConfig, or to https://${domain}.
scopes: The scopes granted to the profile.
origin: The origin of the call. This helps categorize inbound traffic.

Response

Type: AuthToken
Error: ReachFiveError

AuthToken

The authentication token.

idToken

The ID token JSON Web Token (JWT) that contains the profile’s information. This is only available when the openid scope is requested.

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:

AuthCanceled: Nothing happened, and nothing is expected of you — ignoring it is a valid way to handle it.
This can happen for any of the following reasons:
- The user canceled the request.
- No passkey was saved for your app.
- A web login was dropped because another one was already in progress. See webviewLogin.
- The app is not associated with the host of an WebProvider .universalLink callback. See guides/apple-app-site-association.adoc#webcredentials.
RequestError(apiError: ApiError) for a Bad Request (status 400) error.
AuthFailure(reason: String, apiError: ApiError?) mainly for Unauthorized (status 401) error.
TechnicalError(reason: String, apiError: ApiError?) if it’s an Internal Server Error (status 500) or other internal errors.

ApiError

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 OS and app 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.