References

WebAuthn Types

Type Aliases

APIInterface

type APIInterface = object;

Defined in: recipe/webauthn/types.ts:477

Properties

Property	Type	Defined in
emailExistsGET	\| undefined \| (input) => Promise< \| { exists: boolean; status: "OK"; } \| GeneralErrorResponse>	recipe/webauthn/types.ts:655
generateRecoverAccountTokenPOST	\| undefined \| (input) => Promise< \| { status: "OK"; } \| GeneralErrorResponse \| GenerateRecoverAccountTokenPOSTErrorResponse>	recipe/webauthn/types.ts:580
listCredentialsGET	\| undefined \| (input) => Promise< \| { credentials: object[]; status: "OK"; } \| GeneralErrorResponse>	recipe/webauthn/types.ts:609
recoverAccountPOST	\| undefined \| (input) => Promise< \| { email: string; status: "OK"; user: User; } \| GeneralErrorResponse \| RecoverAccountPOSTErrorResponse>	recipe/webauthn/types.ts:590
registerCredentialPOST	\| undefined \| (input) => Promise< \| { status: "OK"; } \| GeneralErrorResponse \| RegisterCredentialPOSTErrorResponse>	recipe/webauthn/types.ts:623
registerOptionsPOST	\| undefined \| (input) => Promise< \| { attestation: "none" \| "indirect" \| "direct" \| "enterprise"; authenticatorSelection: { requireResidentKey: boolean; residentKey: ResidentKey; userVerification: UserVerification; }; challenge: string; createdAt: number; excludeCredentials: object[]; expiresAt: number; pubKeyCredParams: object[]; rp: { id: string; name: string; }; status: "OK"; timeout: number; user: { displayName: string; id: string; name: string; }; webauthnGeneratedOptionsId: string; } \| GeneralErrorResponse \| RegisterOptionsPOSTErrorResponse>	recipe/webauthn/types.ts:478
removeCredentialPOST	\| undefined \| (input) => Promise< \| { status: "OK"; } \| GeneralErrorResponse \| RemoveCredentialPOSTErrorResponse>	recipe/webauthn/types.ts:640
signInOptionsPOST	\| undefined \| (input) => Promise< \| { challenge: string; createdAt: number; expiresAt: number; rpId: string; status: "OK"; timeout: number; userVerification: UserVerification; webauthnGeneratedOptionsId: string; } \| GeneralErrorResponse \| SignInOptionsPOSTErrorResponse>	recipe/webauthn/types.ts:523
signInPOST	\| undefined \| (input) => Promise< \| { session: SessionContainerInterface; status: "OK"; user: User; } \| GeneralErrorResponse \| SignInPOSTErrorResponse>	recipe/webauthn/types.ts:560
signUpPOST	\| undefined \| (input) => Promise< \| { session: SessionContainerInterface; status: "OK"; user: User; } \| GeneralErrorResponse \| SignUpPOSTErrorResponse>	recipe/webauthn/types.ts:540

APIOptions

type APIOptions = object;

Defined in: recipe/webauthn/types.ts:420

Properties

Property	Type	Defined in
appInfo	NormalisedAppinfo	recipe/webauthn/types.ts:422
config	TypeNormalisedInput	recipe/webauthn/types.ts:423
emailDelivery	EmailDeliveryIngredient<TypeWebauthnEmailDeliveryInput>	recipe/webauthn/types.ts:428
isInServerlessEnv	boolean	recipe/webauthn/types.ts:425
recipeId	string	recipe/webauthn/types.ts:424
recipeImplementation	RecipeInterface	recipe/webauthn/types.ts:421
req	BaseRequest	recipe/webauthn/types.ts:426
res	BaseResponse	recipe/webauthn/types.ts:427

Attestation

type Attestation = "none" | "indirect" | "direct" | "enterprise";

Defined in: recipe/webauthn/types.ts:173

AuthenticationPayload

type AuthenticationPayload = CredentialPayloadBase & object;

Defined in: recipe/webauthn/types.ts:703

Type Declaration

Name	Type	Defined in
response	AuthenticatorAssertionResponseJSON	recipe/webauthn/types.ts:704

AuthenticatorAssertionResponseJSON

type AuthenticatorAssertionResponseJSON = object;

Defined in: recipe/webauthn/types.ts:687

Properties

Property	Type	Defined in
authenticatorData	Base64URLString	recipe/webauthn/types.ts:689
clientDataJSON	Base64URLString	recipe/webauthn/types.ts:688
signature	Base64URLString	recipe/webauthn/types.ts:690
userHandle?	Base64URLString	recipe/webauthn/types.ts:691

AuthenticatorAttestationResponseJSON

type AuthenticatorAttestationResponseJSON = object;

Defined in: recipe/webauthn/types.ts:694

Properties

Property	Type	Defined in
attestationObject	Base64URLString	recipe/webauthn/types.ts:696
authenticatorData?	Base64URLString	recipe/webauthn/types.ts:697
clientDataJSON	Base64URLString	recipe/webauthn/types.ts:695
publicKey?	Base64URLString	recipe/webauthn/types.ts:700
publicKeyAlgorithm?	COSEAlgorithmIdentifier	recipe/webauthn/types.ts:699
transports?	("ble" \| "cable" \| "hybrid" \| "internal" \| "nfc" \| "smart-card" \| "usb")[]	recipe/webauthn/types.ts:698

CredentialPayload

type CredentialPayload = CredentialPayloadBase & object;

Defined in: recipe/webauthn/types.ts:711

Type Declaration

Name	Type	Defined in
response	object	recipe/webauthn/types.ts:712
response.attestationObject	string	recipe/webauthn/types.ts:714
response.clientDataJSON	string	recipe/webauthn/types.ts:713
response.transports?	("ble" \| "cable" \| "hybrid" \| "internal" \| "nfc" \| "smart-card" \| "usb")[]	recipe/webauthn/types.ts:715
response.userHandle	string	recipe/webauthn/types.ts:716

CredentialPayloadBase

type CredentialPayloadBase = object;

Defined in: recipe/webauthn/types.ts:679

Properties

Property	Type	Defined in
authenticatorAttachment?	"platform" \| "cross-platform"	recipe/webauthn/types.ts:682
clientExtensionResults	Record<string, unknown>	recipe/webauthn/types.ts:683
id	string	recipe/webauthn/types.ts:680
rawId	string	recipe/webauthn/types.ts:681
type	"public-key"	recipe/webauthn/types.ts:684

RecipeInterface

type RecipeInterface = object;

Defined in: recipe/webauthn/types.ts:175

Methods

consumeRecoverAccountToken()

consumeRecoverAccountToken(input): Promise<
  | {
  email: string;
  status: "OK";
  userId: string;
}
| ConsumeRecoverAccountTokenErrorResponse>;

Defined in: recipe/webauthn/types.ts:322

Parameters

Parameter	Type
input	{ tenantId: string; token: string; userContext: UserContext; }
input.tenantId	string
input.token	string
input.userContext	UserContext

Returns

Promise< | { email: string; status: "OK"; userId: string; } | ConsumeRecoverAccountTokenErrorResponse>

createNewRecipeUser()

createNewRecipeUser(input): Promise<
  | CreateNewRecipeUserErrorResponse
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}>;

Defined in: recipe/webauthn/types.ts:296

This function is meant only for creating the recipe in the core and nothing else. We added this even though signUp exists cause devs may override signup expecting it to be called just during sign up. But we also need a version of signing up which can be called during operations like creating a user during account recovery flow.

Parameters

Parameter	Type
input	{ credential: RegistrationPayload; tenantId: string; userContext: UserContext; webauthnGeneratedOptionsId: string; }
input.credential	RegistrationPayload
input.tenantId	string
input.userContext	UserContext
input.webauthnGeneratedOptionsId	string

Returns

Promise< | CreateNewRecipeUserErrorResponse | { recipeUserId: RecipeUserId; status: "OK"; user: User; }>

generateRecoverAccountToken()

generateRecoverAccountToken(input): Promise<
  | {
  status: "OK";
  token: string;
}
| GenerateRecoverAccountTokenErrorResponse>;

Defined in: recipe/webauthn/types.ts:315

We pass in the email as well to this function cause the input userId may not be associated with an webauthn account. In this case, we need to know which email to use to create an webauthn account later on.

Parameters

Parameter	Type
input	{ email: string; tenantId: string; userContext: UserContext; userId: string; }
input.email	string
input.tenantId	string
input.userContext	UserContext
input.userId	string

Returns

Promise< | { status: "OK"; token: string; } | GenerateRecoverAccountTokenErrorResponse>

getCredential()

getCredential(input): Promise<
  | {
  createdAt: number;
  recipeUserId: RecipeUserId;
  relyingPartyId: string;
  status: "OK";
  webauthnCredentialId: string;
}
| GetCredentialErrorResponse>;

Defined in: recipe/webauthn/types.ts:358

Parameters

Parameter	Type
input	{ recipeUserId: string; userContext: UserContext; webauthnCredentialId: string; }
input.recipeUserId	string
input.userContext	UserContext
input.webauthnCredentialId	string

Returns

Promise< | { createdAt: number; recipeUserId: RecipeUserId; relyingPartyId: string; status: "OK"; webauthnCredentialId: string; } | GetCredentialErrorResponse>

getGeneratedOptions()

getGeneratedOptions(input): Promise<
  | {
  challenge: string;
  createdAt: number;
  email?: string;
  expiresAt: number;
  origin: string;
  relyingPartyId: string;
  relyingPartyName: string;
  status: "OK";
  timeout: number;
  userPresence: boolean;
  userVerification: UserVerification;
  webauthnGeneratedOptionsId: string;
}
| GetGeneratedOptionsErrorResponse>;

Defined in: recipe/webauthn/types.ts:385

Parameters

Parameter	Type
input	{ tenantId: string; userContext: UserContext; webauthnGeneratedOptionsId: string; }
input.tenantId	string
input.userContext	UserContext
input.webauthnGeneratedOptionsId	string

Returns

Promise< | { challenge: string; createdAt: number; email?: string; expiresAt: number; origin: string; relyingPartyId: string; relyingPartyName: string; status: "OK"; timeout: number; userPresence: boolean; userVerification: UserVerification; webauthnGeneratedOptionsId: string; } | GetGeneratedOptionsErrorResponse>

getUserFromRecoverAccountToken()

getUserFromRecoverAccountToken(input): Promise<
  | {
  recipeUserId?: RecipeUserId;
  status: "OK";
  user: User;
}
| GetUserFromRecoverAccountTokenErrorResponse>;

Defined in: recipe/webauthn/types.ts:343

Parameters

Parameter	Type
input	{ tenantId: string; token: string; userContext: UserContext; }
input.tenantId	string
input.token	string
input.userContext	UserContext

Returns

Promise< | { recipeUserId?: RecipeUserId; status: "OK"; user: User; } | GetUserFromRecoverAccountTokenErrorResponse>

listCredentials()

listCredentials(input): Promise<{
  credentials: object[];
  status: "OK";
}>;

Defined in: recipe/webauthn/types.ts:369

Parameters

Parameter	Type
input	{ recipeUserId: string; userContext: UserContext; }
input.recipeUserId	string
input.userContext	UserContext

Returns

Promise<{ credentials: object[]; status: "OK"; }>

registerCredential()

registerCredential(input): Promise<
  | {
  status: "OK";
}
| RegisterCredentialErrorResponse>;

Defined in: recipe/webauthn/types.ts:331

Parameters

Parameter	Type
input	{ credential: RegistrationPayload; recipeUserId: string; userContext: UserContext; webauthnGeneratedOptionsId: string; }
input.credential	RegistrationPayload
input.recipeUserId	string
input.userContext	UserContext
input.webauthnGeneratedOptionsId	string

Returns

Promise< | { status: "OK"; } | RegisterCredentialErrorResponse>

registerOptions()

registerOptions(input): Promise<
  | {
  attestation: Attestation;
  authenticatorSelection: {
     requireResidentKey: boolean;
     residentKey: ResidentKey;
     userVerification: UserVerification;
  };
  challenge: string;
  createdAt: number;
  excludeCredentials: object[];
  expiresAt: number;
  pubKeyCredParams: object[];
  rp: {
     id: string;
     name: string;
  };
  status: "OK";
  timeout: number;
  user: {
     displayName: string;
     id: string;
     name: string;
  };
  webauthnGeneratedOptionsId: string;
}
| RegisterOptionsErrorResponse>;

Defined in: recipe/webauthn/types.ts:176

Parameters

Parameter	Type
input	object & \| { recoverAccountToken: string; } \| { displayName: string \| undefined; email: string; }

Returns

Promise< | { attestation: Attestation; authenticatorSelection: { requireResidentKey: boolean; residentKey: ResidentKey; userVerification: UserVerification; }; challenge: string; createdAt: number; excludeCredentials: object[]; expiresAt: number; pubKeyCredParams: object[]; rp: { id: string; name: string; }; status: "OK"; timeout: number; user: { displayName: string; id: string; name: string; }; webauthnGeneratedOptionsId: string; } | RegisterOptionsErrorResponse>

removeCredential()

removeCredential(input): Promise<
  | {
  status: "OK";
}
| RemoveCredentialErrorResponse>;

Defined in: recipe/webauthn/types.ts:351

Parameters

Parameter	Type
input	{ recipeUserId: string; userContext: UserContext; webauthnCredentialId: string; }
input.recipeUserId	string
input.userContext	UserContext
input.webauthnCredentialId	string

Returns

Promise< | { status: "OK"; } | RemoveCredentialErrorResponse>

removeGeneratedOptions()

removeGeneratedOptions(input): Promise<
  | {
  status: "OK";
}
| RemoveGeneratedOptionsErrorResponse>;

Defined in: recipe/webauthn/types.ts:379

Parameters

Parameter	Type
input	{ tenantId: string; userContext: UserContext; webauthnGeneratedOptionsId: string; }
input.tenantId	string
input.userContext	UserContext
input.webauthnGeneratedOptionsId	string

Returns

Promise< | { status: "OK"; } | RemoveGeneratedOptionsErrorResponse>

signIn(input): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
| SignInErrorResponse>;

Defined in: recipe/webauthn/types.ts:274

Parameters

Parameter	Type
input	{ credential: AuthenticationPayload; session: SessionContainerInterface \| undefined; shouldTryLinkingWithSessionUser: boolean \| undefined; tenantId: string; userContext: UserContext; webauthnGeneratedOptionsId: string; }
input.credential	AuthenticationPayload
input.session	SessionContainerInterface \| undefined
input.shouldTryLinkingWithSessionUser	boolean \| undefined
input.tenantId	string
input.userContext	UserContext
input.webauthnGeneratedOptionsId	string

Returns

Promise< | { recipeUserId: RecipeUserId; status: "OK"; user: User; } | SignInErrorResponse>

signInOptions()

signInOptions(input): Promise<
  | {
  challenge: string;
  createdAt: number;
  expiresAt: number;
  status: "OK";
  timeout: number;
  userVerification: UserVerification;
  webauthnGeneratedOptionsId: string;
}
| SignInOptionsErrorResponse>;

Defined in: recipe/webauthn/types.ts:236

Parameters

Parameter	Type
input	{ origin: string; relyingPartyId: string; relyingPartyName: string; tenantId: string; timeout: number \| undefined; userContext: UserContext; userPresence: boolean \| undefined; userVerification: UserVerification \| undefined; }
input.origin	string
input.relyingPartyId	string
input.relyingPartyName	string
input.tenantId	string
input.timeout	number \| undefined
input.userContext	UserContext
input.userPresence	boolean \| undefined
input.userVerification	UserVerification \| undefined

Returns

Promise< | { challenge: string; createdAt: number; expiresAt: number; status: "OK"; timeout: number; userVerification: UserVerification; webauthnGeneratedOptionsId: string; } | SignInOptionsErrorResponse>

signUp(input): Promise<
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}
| SignUpErrorResponse>;

Defined in: recipe/webauthn/types.ts:258

Parameters

Parameter	Type
input	{ credential: RegistrationPayload; session: SessionContainerInterface \| undefined; shouldTryLinkingWithSessionUser: boolean \| undefined; tenantId: string; userContext: UserContext; webauthnGeneratedOptionsId: string; }
input.credential	RegistrationPayload
input.session	SessionContainerInterface \| undefined
input.shouldTryLinkingWithSessionUser	boolean \| undefined
input.tenantId	string
input.userContext	UserContext
input.webauthnGeneratedOptionsId	string

Returns

Promise< | { recipeUserId: RecipeUserId; status: "OK"; user: User; } | SignUpErrorResponse>

updateUserEmail()

updateUserEmail(input): Promise<
  | {
  status: "OK";
}
| UpdateUserEmailErrorResponse>;

Defined in: recipe/webauthn/types.ts:407

Parameters

Parameter	Type
input	{ email: string; recipeUserId: string; tenantId: string; userContext: UserContext; }
input.email	string
input.recipeUserId	string
input.tenantId	string
input.userContext	UserContext

Returns

Promise< | { status: "OK"; } | UpdateUserEmailErrorResponse>

verifyCredentials()

verifyCredentials(input): Promise<
  | VerifyCredentialsErrorResponse
  | {
  recipeUserId: RecipeUserId;
  status: "OK";
  user: User;
}>;

Defined in: recipe/webauthn/types.ts:283

Parameters

Parameter	Type
input	{ credential: AuthenticationPayload; tenantId: string; userContext: UserContext; webauthnGeneratedOptionsId: string; }
input.credential	AuthenticationPayload
input.tenantId	string
input.userContext	UserContext
input.webauthnGeneratedOptionsId	string

Returns

Promise< | VerifyCredentialsErrorResponse | { recipeUserId: RecipeUserId; status: "OK"; user: User; }>

RegistrationPayload

type RegistrationPayload = CredentialPayloadBase & object;

Defined in: recipe/webauthn/types.ts:707

Type Declaration

Name	Type	Defined in
response	AuthenticatorAttestationResponseJSON	recipe/webauthn/types.ts:708

ResidentKey

type ResidentKey = "required" | "preferred" | "discouraged";

Defined in: recipe/webauthn/types.ts:171

TypeInput

type TypeInput = object;

Defined in: recipe/webauthn/types.ts:68

Properties

Property	Type	Defined in
emailDelivery?	EmailDeliveryTypeInput<TypeWebauthnEmailDeliveryInput>	recipe/webauthn/types.ts:69
getOrigin?	TypeInputGetOrigin	recipe/webauthn/types.ts:73
getRelyingPartyId?	TypeInputRelyingPartyId	recipe/webauthn/types.ts:70
getRelyingPartyName?	TypeInputRelyingPartyName	recipe/webauthn/types.ts:71
override?	object	recipe/webauthn/types.ts:74
override.apis?	(originalImplementation, builder) => APIInterface	recipe/webauthn/types.ts:79
override.functions?	(originalImplementation, builder) => RecipeInterface	recipe/webauthn/types.ts:75
validateEmailAddress?	TypeInputValidateEmailAddress	recipe/webauthn/types.ts:72

TypeInputGetOrigin()

type TypeInputGetOrigin = (input) => Promise<string>;

Defined in: recipe/webauthn/types.ts:91

Parameters

Parameter	Type
input	{ request: BaseRequest; tenantId: string; userContext: UserContext; }
input.request	BaseRequest
input.tenantId	string
input.userContext	UserContext

Returns

Promise<string>

TypeInputRelyingPartyId

type TypeInputRelyingPartyId = string | (input) => Promise<string>;

Defined in: recipe/webauthn/types.ts:83

TypeInputRelyingPartyName

type TypeInputRelyingPartyName = string | (input) => Promise<string>;

Defined in: recipe/webauthn/types.ts:87

TypeInputValidateEmailAddress()

type TypeInputValidateEmailAddress = (email, tenantId, userContext) => Promise<string | undefined> | string | undefined;

Defined in: recipe/webauthn/types.ts:97

Parameters

Parameter	Type
email	string
tenantId	string
userContext	UserContext

Returns

Promise<string | undefined> | string | undefined

TypeNormalisedInput

type TypeNormalisedInput = object;

Defined in: recipe/webauthn/types.ts:27

Properties

Property	Type	Defined in
getEmailDeliveryConfig	(isInServerlessEnv) => EmailDeliveryTypeInputWithService<TypeWebauthnEmailDeliveryInput>	recipe/webauthn/types.ts:31
getOrigin	TypeNormalisedInputGetOrigin	recipe/webauthn/types.ts:30
getRelyingPartyId	TypeNormalisedInputRelyingPartyId	recipe/webauthn/types.ts:28
getRelyingPartyName	TypeNormalisedInputRelyingPartyName	recipe/webauthn/types.ts:29
override	object	recipe/webauthn/types.ts:35
override.apis	(originalImplementation, builder) => APIInterface	recipe/webauthn/types.ts:40
override.functions	(originalImplementation, builder) => RecipeInterface	recipe/webauthn/types.ts:36
validateEmailAddress	TypeNormalisedInputValidateEmailAddress	recipe/webauthn/types.ts:34

TypeNormalisedInputGetOrigin()

type TypeNormalisedInputGetOrigin = (input) => Promise<string>;

Defined in: recipe/webauthn/types.ts:56

Parameters

Parameter	Type
input	{ request: BaseRequest; tenantId: string; userContext: UserContext; }
input.request	BaseRequest
input.tenantId	string
input.userContext	UserContext

Returns

Promise<string>

TypeNormalisedInputRelyingPartyId()

type TypeNormalisedInputRelyingPartyId = (input) => Promise<string>;

Defined in: recipe/webauthn/types.ts:44

Parameters

Parameter	Type
input	{ request: BaseRequest \| undefined; tenantId: string; userContext: UserContext; }
input.request	BaseRequest \| undefined
input.tenantId	string
input.userContext	UserContext

Returns

Promise<string>

TypeNormalisedInputRelyingPartyName()

type TypeNormalisedInputRelyingPartyName = (input) => Promise<string>;

Defined in: recipe/webauthn/types.ts:50

Parameters

Parameter	Type
input	{ request: BaseRequest \| undefined; tenantId: string; userContext: UserContext; }
input.request	BaseRequest \| undefined
input.tenantId	string
input.userContext	UserContext

Returns

Promise<string>

TypeNormalisedInputValidateEmailAddress()

type TypeNormalisedInputValidateEmailAddress = (email, tenantId, userContext) => Promise<string | undefined> | string | undefined;

Defined in: recipe/webauthn/types.ts:62

Parameters

Parameter	Type
email	string
tenantId	string
userContext	UserContext

Returns

Promise<string | undefined> | string | undefined

TypeWebauthnEmailDeliveryInput

type TypeWebauthnEmailDeliveryInput = TypeWebauthnRecoverAccountEmailDeliveryInput;

Defined in: recipe/webauthn/types.ts:677

TypeWebauthnRecoverAccountEmailDeliveryInput

type TypeWebauthnRecoverAccountEmailDeliveryInput = object;

Defined in: recipe/webauthn/types.ts:666

Properties

Property	Type	Defined in
recoverAccountLink	string	recipe/webauthn/types.ts:673
tenantId	string	recipe/webauthn/types.ts:674
type	"RECOVER_ACCOUNT"	recipe/webauthn/types.ts:667
user	object	recipe/webauthn/types.ts:668
user.email	string	recipe/webauthn/types.ts:671
user.id	string	recipe/webauthn/types.ts:669
user.recipeUserId	RecipeUserId \| undefined	recipe/webauthn/types.ts:670

UserVerification

type UserVerification = "required" | "preferred" | "discouraged";

Defined in: recipe/webauthn/types.ts:172

Type Aliases

APIInterface

Properties

APIOptions

Properties

Attestation

AuthenticationPayload

Type Declaration

AuthenticatorAssertionResponseJSON

Properties

AuthenticatorAttestationResponseJSON

Properties

CredentialPayload

Type Declaration

CredentialPayloadBase

Properties

RecipeInterface

Methods

consumeRecoverAccountToken()​

Parameters​

Returns​

createNewRecipeUser()​

Parameters​

Returns​

generateRecoverAccountToken()​

Parameters​

Returns​

getCredential()​

Parameters​

Returns​

getGeneratedOptions()​

Parameters​

Returns​

getUserFromRecoverAccountToken()​

Parameters​

Returns​

listCredentials()​

Parameters​

Returns​

registerCredential()​

Parameters​

Returns​

registerOptions()​

Parameters​

Returns​

removeCredential()​

Parameters​

Returns​

removeGeneratedOptions()​

Parameters​

Returns​

signIn()​

Parameters​

Returns​

signInOptions()​

Parameters​

Returns​

signUp()​

Parameters​

Returns​

updateUserEmail()​

Parameters​

Returns​

verifyCredentials()​

Parameters​

Returns​

RegistrationPayload

Type Declaration

ResidentKey

TypeInput

Properties

TypeInputGetOrigin()

Parameters

Returns

TypeInputRelyingPartyId

TypeInputRelyingPartyName

TypeInputValidateEmailAddress()

Parameters

Returns

TypeNormalisedInput

consumeRecoverAccountToken()

Parameters

Returns

createNewRecipeUser()

Parameters

Returns

generateRecoverAccountToken()

Parameters

Returns

getCredential()

Parameters

Returns

getGeneratedOptions()

Parameters

Returns

getUserFromRecoverAccountToken()

Parameters

Returns

listCredentials()

Parameters

Returns

registerCredential()

Parameters

Returns

registerOptions()

Parameters

Returns

removeCredential()

Parameters

Returns

removeGeneratedOptions()

Parameters

Returns

signIn()

Parameters

Returns

signInOptions()

Parameters

Returns

signUp()

Parameters

Returns

updateUserEmail()

Parameters

Returns

verifyCredentials()

Parameters

Returns