---
title: supertokens-web-js/recipe/webauthn/types
description: References documentation for the supertokens-web-js/recipe/webauthn/types package
sidebar:
  order: 230
---

## Type Aliases

### AuthenticationOptions

```ts check=false reason="Generated API signature"
type AuthenticationOptions = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:116](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L116)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="challenge"></a> `challenge` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:119](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L119) |
| <a id="fetchresponse"></a> `fetchResponse` | `Response` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:122](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L122) |
| <a id="status"></a> `status` | `"OK"` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:117](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L117) |
| <a id="timeout"></a> `timeout` | `number` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:120](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L120) |
| <a id="member-authenticationoptions-userverification"></a> `userVerification` | [`UserVerification`](#userverification) | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:121](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L121) |
| <a id="webauthngeneratedoptionsid"></a> `webauthnGeneratedOptionsId` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:118](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L118) |

***

### CredentialPayload

```ts check=false reason="Generated API signature"
type CredentialPayload = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:68](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L68)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="authenticatorattachment"></a> `authenticatorAttachment` | `"platform"` \| `"cross-platform"` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:77](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L77) |
| <a id="clientextensionresults"></a> `clientExtensionResults` | `any` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:78](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L78) |
| <a id="id"></a> `id` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:69](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L69) |
| <a id="rawid"></a> `rawId` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:70](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L70) |
| <a id="response"></a> `response` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:71](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L71) |
| `response.attestationObject` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:73](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L73) |
| `response.clientDataJSON` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:72](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L72) |
| `response.transports?` | (`"ble"` \| `"cable"` \| `"hybrid"` \| `"internal"` \| `"nfc"` \| `"smart-card"` \| `"usb"`)[] | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:74](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L74) |
| `response.userHandle` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:75](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L75) |
| <a id="type"></a> `type` | `"public-key"` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:79](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L79) |

***

### InputType

```ts check=false reason="Generated API signature"
type InputType = AuthRecipeInputType<PreAndPostAPIHookAction> & UserInput;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:57](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L57)

***

### NormalisedInputType

```ts check=false reason="Generated API signature"
type NormalisedInputType = AuthRecipeNormalisedInputType<PreAndPostAPIHookAction> & object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:59](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L59)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:60](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L60) |
| `override.functions()` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:61](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L61) |

***

### PostAPIHookContext

```ts check=false reason="Generated API signature"
type PostAPIHookContext = RecipePostAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:43](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L43)

***

### PreAndPostAPIHookAction

```ts check=false reason="Generated API signature"
type PreAndPostAPIHookAction = 
  | "REGISTER_OPTIONS"
  | "SIGN_IN_OPTIONS"
  | "SIGN_UP"
  | "SIGN_IN"
  | "EMAIL_EXISTS"
  | "GENERATE_RECOVER_ACCOUNT_TOKEN"
  | "RECOVER_ACCOUNT"
  | "LIST_CREDENTIALS"
  | "REMOVE_CREDENTIAL"
  | "REGISTER_CREDENTIAL";
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:30](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L30)

***

### PreAPIHookContext

```ts check=false reason="Generated API signature"
type PreAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:42](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L42)

***

### RecipeInterface

```ts check=false reason="Generated API signature"
type RecipeInterface = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:125](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L125)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="authenticatecredential"></a> `authenticateCredential` | (`input`) => `Promise`\< \| \{ `authenticationResponse`: `AuthenticationResponseJSON`; `status`: `"OK"`; \} \| \{ `error`: `any`; `status`: `"FAILED_TO_AUTHENTICATE_USER"`; \} \| \{ `error`: `any`; `status`: `"WEBAUTHN_NOT_SUPPORTED"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:251](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L251) |
| <a id="authenticatecredentialwithsignin"></a> `authenticateCredentialWithSignIn` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; `user`: [`User`](types#user); \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_OPTIONS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_CREDENTIALS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"SIGN_IN_NOT_ALLOWED"`; \} \| \{ `error`: `any`; `status`: `"FAILED_TO_AUTHENTICATE_USER"`; \} \| \{ `error`: `any`; `status`: `"WEBAUTHN_NOT_SUPPORTED"`; \} \| [`GeneralErrorResponse`](types#generalerrorresponse)\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:293](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L293) |
| <a id="createandregistercredentialforsessionuser"></a> `createAndRegisterCredentialForSessionUser` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types#generalerrorresponse) \| \{ `reason?`: `string`; `status`: `"REGISTER_CREDENTIAL_NOT_ALLOWED"`; \} \| \{ `err`: `string`; `status`: `"INVALID_EMAIL_ERROR"`; \} \| \{ `status`: `"INVALID_CREDENTIALS_ERROR"`; \} \| \{ `status`: `"OPTIONS_NOT_FOUND_ERROR"`; \} \| \{ `status`: `"INVALID_OPTIONS_ERROR"`; \} \| \{ `reason?`: `string`; `status`: `"INVALID_AUTHENTICATOR_ERROR"`; \} \| \{ `status`: `"AUTHENTICATOR_ALREADY_REGISTERED"`; \} \| \{ `error`: `any`; `status`: `"FAILED_TO_REGISTER_USER"`; \} \| \{ `error`: `any`; `status`: `"WEBAUTHN_NOT_SUPPORTED"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:338](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L338) |
| <a id="createcredential"></a> `createCredential` | (`input`) => `Promise`\< \| \{ `registrationResponse`: `RegistrationResponseJSON`; `status`: `"OK"`; \} \| \{ `status`: `"AUTHENTICATOR_ALREADY_REGISTERED"`; \} \| \{ `error`: `any`; `status`: `"FAILED_TO_REGISTER_USER"`; \} \| \{ `error`: `any`; `status`: `"WEBAUTHN_NOT_SUPPORTED"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:239](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L239) |
| <a id="doesbrowsersupportwebauthn"></a> `doesBrowserSupportWebAuthn` | (`input`) => `Promise`\< \| \{ `browserSupportsWebauthn`: `boolean`; `platformAuthenticatorIsAvailable`: `boolean`; `status`: `"OK"`; \} \| \{ `error`: `any`; `status`: `"ERROR"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:406](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L406) |
| <a id="generaterecoveraccounttoken"></a> `generateRecoverAccountToken` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"RECOVER_ACCOUNT_NOT_ALLOWED"`; \} \| [`GeneralErrorResponse`](types#generalerrorresponse)\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:207](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L207) |
| <a id="getemailexists"></a> `getEmailExists` | (`input`) => `Promise`\< \| \{ `exists`: `boolean`; `fetchResponse`: `Response`; `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types#generalerrorresponse)\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:199](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L199) |
| <a id="getregisteroptions"></a> `getRegisterOptions` | (`input`) => `Promise`\< \| [`RegistrationOptions`](#registrationoptions) \| \{ `fetchResponse`: `Response`; `status`: `"RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"`; \} \| \{ `err`: `string`; `fetchResponse`: `Response`; `status`: `"INVALID_EMAIL_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_OPTIONS_ERROR"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:126](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L126) |
| <a id="getsigninoptions"></a> `getSignInOptions` | (`input`) => `Promise`\< \| [`AuthenticationOptions`](#authenticationoptions) \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_OPTIONS_ERROR"`; \} \| [`GeneralErrorResponse`](types#generalerrorresponse)\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:147](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L147) |
| <a id="listcredentials"></a> `listCredentials` | (`input`) => `Promise`\< \| \{ `credentials`: `object`[]; `fetchResponse`: `Response`; `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types#generalerrorresponse)\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:359](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L359) |
| <a id="recoveraccount"></a> `recoverAccount` | (`input`) => `Promise`\< \| \{ `email`: `string`; `fetchResponse`: `Response`; `status`: `"OK"`; `user`: [`User`](types#user); \} \| [`GeneralErrorResponse`](types#generalerrorresponse) \| \{ `fetchResponse`: `Response`; `status`: `"RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_CREDENTIALS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"OPTIONS_NOT_FOUND_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_OPTIONS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"INVALID_AUTHENTICATOR_ERROR"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:219](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L219) |
| <a id="registercredential"></a> `registerCredential` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types#generalerrorresponse) \| \{ `fetchResponse`: `Response`; `reason?`: `string`; `status`: `"REGISTER_CREDENTIAL_NOT_ALLOWED"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_CREDENTIALS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"OPTIONS_NOT_FOUND_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_OPTIONS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `reason?`: `string`; `status`: `"INVALID_AUTHENTICATOR_ERROR"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:384](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L384) |
| <a id="registercredentialwithrecoveraccount"></a> `registerCredentialWithRecoverAccount` | (`input`) => `Promise`\< \| \{ `email`: `string`; `fetchResponse`: `Response`; `status`: `"OK"`; `user`: [`User`](types#user); \} \| \{ `fetchResponse`: `Response`; `status`: `"RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_OPTIONS_ERROR"`; \} \| [`GeneralErrorResponse`](types#generalerrorresponse) \| \{ `fetchResponse`: `Response`; `status`: `"RECOVER_ACCOUNT_TOKEN_INVALID_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_CREDENTIALS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"OPTIONS_NOT_FOUND_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"INVALID_AUTHENTICATOR_ERROR"`; \} \| \{ `status`: `"AUTHENTICATOR_ALREADY_REGISTERED"`; \} \| \{ `error`: `any`; `status`: `"FAILED_TO_REGISTER_USER"`; \} \| \{ `error`: `any`; `status`: `"WEBAUTHN_NOT_SUPPORTED"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:310](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L310) |
| <a id="registercredentialwithsignup"></a> `registerCredentialWithSignUp` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; `user`: [`User`](types#user); \} \| \{ `err`: `string`; `fetchResponse`: `Response`; `status`: `"INVALID_EMAIL_ERROR"`; \} \| [`GeneralErrorResponse`](types#generalerrorresponse) \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"SIGN_UP_NOT_ALLOWED"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_CREDENTIALS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"OPTIONS_NOT_FOUND_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_OPTIONS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"INVALID_AUTHENTICATOR_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"EMAIL_ALREADY_EXISTS_ERROR"`; \} \| \{ `status`: `"AUTHENTICATOR_ALREADY_REGISTERED"`; \} \| \{ `error`: `any`; `status`: `"FAILED_TO_REGISTER_USER"`; \} \| \{ `error`: `any`; `status`: `"WEBAUTHN_NOT_SUPPORTED"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:262](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L262) |
| <a id="removecredential"></a> `removeCredential` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; \} \| [`GeneralErrorResponse`](types#generalerrorresponse) \| \{ `fetchResponse`: `Response`; `status`: `"CREDENTIAL_NOT_FOUND_ERROR"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:372](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L372) |
| <a id="signin"></a> `signIn` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; `user`: [`User`](types#user); \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_CREDENTIALS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"SIGN_IN_NOT_ALLOWED"`; \} \| [`GeneralErrorResponse`](types#generalerrorresponse)\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:179](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L179) |
| <a id="signup"></a> `signUp` | (`input`) => `Promise`\< \| \{ `fetchResponse`: `Response`; `status`: `"OK"`; `user`: [`User`](types#user); \} \| [`GeneralErrorResponse`](types#generalerrorresponse) \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"SIGN_UP_NOT_ALLOWED"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_CREDENTIALS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"OPTIONS_NOT_FOUND_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"INVALID_OPTIONS_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `reason`: `string`; `status`: `"INVALID_AUTHENTICATOR_ERROR"`; \} \| \{ `fetchResponse`: `Response`; `status`: `"EMAIL_ALREADY_EXISTS_ERROR"`; \}\> | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:155](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L155) |

***

### RegistrationOptions

```ts check=false reason="Generated API signature"
type RegistrationOptions = object;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:82](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L82)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="attestation"></a> `attestation` | `"none"` \| `"indirect"` \| `"direct"` \| `"enterprise"` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:103](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L103) |
| <a id="authenticatorselection"></a> `authenticatorSelection` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:108](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L108) |
| `authenticatorSelection.requireResidentKey` | `boolean` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:109](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L109) |
| `authenticatorSelection.residentKey` | [`ResidentKey`](#residentkey) | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:110](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L110) |
| `authenticatorSelection.userVerification` | [`UserVerification`](#userverification) | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:111](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L111) |
| <a id="challenge-1"></a> `challenge` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:96](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L96) |
| <a id="createdat"></a> `createdAt` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:85](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L85) |
| <a id="excludecredentials"></a> `excludeCredentials` | `object`[] | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:98](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L98) |
| <a id="expiresat"></a> `expiresAt` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:86](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L86) |
| <a id="fetchresponse-1"></a> `fetchResponse` | `Response` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:113](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L113) |
| <a id="pubkeycredparams"></a> `pubKeyCredParams` | `object`[] | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:104](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L104) |
| <a id="rp"></a> `rp` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:87](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L87) |
| `rp.id` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:88](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L88) |
| `rp.name` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:89](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L89) |
| <a id="status-1"></a> `status` | `"OK"` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:83](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L83) |
| <a id="timeout-1"></a> `timeout` | `number` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:97](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L97) |
| <a id="user"></a> `user` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:91](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L91) |
| `user.displayName` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:94](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L94) |
| `user.id` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:92](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L92) |
| `user.name` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:93](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L93) |
| <a id="webauthngeneratedoptionsid-1"></a> `webauthnGeneratedOptionsId` | `string` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:84](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L84) |

***

### ResidentKey

```ts check=false reason="Generated API signature"
type ResidentKey = "required" | "preferred" | "discouraged";
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:45](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L45)

***

### UserInput

```ts check=false reason="Generated API signature"
type UserInput = object & RecipeModuleUserInput<PreAndPostAPIHookAction>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:48](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L48)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `override?` | `object` | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:49](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L49) |
| `override.functions()?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:50](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L50) |

***

### UserVerification

```ts check=false reason="Generated API signature"
type UserVerification = "required" | "preferred" | "discouraged";
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/webauthn/types.ts:46](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/webauthn/types.ts#L46)