# Scrapfly Documentation

## Table of Contents

### Dashboard

- [Intro](https://scrapfly.io/docs)
- [Project](https://scrapfly.io/docs/project)
- [Account](https://scrapfly.io/docs/account)
- [Workspace & Team](https://scrapfly.io/docs/workspace-and-team)
- [Billing](https://scrapfly.io/docs/billing)

### Products

#### MCP Server

- [Getting Started](https://scrapfly.io/docs/mcp/getting-started)
- [Tools & API Spec](https://scrapfly.io/docs/mcp/tools)
- [Authentication](https://scrapfly.io/docs/mcp/authentication)
- [Examples & Use Cases](https://scrapfly.io/docs/mcp/examples)
- [FAQ](https://scrapfly.io/docs/mcp/faq)
##### Integrations

- [Overview](https://scrapfly.io/docs/mcp/integrations)
- [Claude Desktop](https://scrapfly.io/docs/mcp/integrations/claude-desktop)
- [Claude Code](https://scrapfly.io/docs/mcp/integrations/claude-code)
- [ChatGPT](https://scrapfly.io/docs/mcp/integrations/chatgpt)
- [Cursor](https://scrapfly.io/docs/mcp/integrations/cursor)
- [Cline](https://scrapfly.io/docs/mcp/integrations/cline)
- [Windsurf](https://scrapfly.io/docs/mcp/integrations/windsurf)
- [Zed](https://scrapfly.io/docs/mcp/integrations/zed)
- [Roo Code](https://scrapfly.io/docs/mcp/integrations/roo-code)
- [VS Code](https://scrapfly.io/docs/mcp/integrations/vscode)
- [LangChain](https://scrapfly.io/docs/mcp/integrations/langchain)
- [LlamaIndex](https://scrapfly.io/docs/mcp/integrations/llamaindex)
- [CrewAI](https://scrapfly.io/docs/mcp/integrations/crewai)
- [OpenAI](https://scrapfly.io/docs/mcp/integrations/openai)
- [n8n](https://scrapfly.io/docs/mcp/integrations/n8n)
- [Make](https://scrapfly.io/docs/mcp/integrations/make)
- [Zapier](https://scrapfly.io/docs/mcp/integrations/zapier)
- [Vapi AI](https://scrapfly.io/docs/mcp/integrations/vapi)
- [Agent Builder](https://scrapfly.io/docs/mcp/integrations/agent-builder)
- [Custom Client](https://scrapfly.io/docs/mcp/integrations/custom-client)


#### Web Scraping API

- [Getting Started](https://scrapfly.io/docs/scrape-api/getting-started)
- [API Specification]()
- [Monitoring](https://scrapfly.io/docs/monitoring)
- [Customize Request](https://scrapfly.io/docs/scrape-api/custom)
- [Debug](https://scrapfly.io/docs/scrape-api/debug)
- [Anti Scraping Protection](https://scrapfly.io/docs/scrape-api/anti-scraping-protection)
- [Proxy](https://scrapfly.io/docs/scrape-api/proxy)
- [Proxy Mode](https://scrapfly.io/docs/scrape-api/proxy-mode)
- [Proxy Mode - Screaming Frog](https://scrapfly.io/docs/scrape-api/proxy-mode/screaming-frog)
- [Proxy Mode - Apify](https://scrapfly.io/docs/scrape-api/proxy-mode/apify)
- [(Auto) Data Extraction](https://scrapfly.io/docs/scrape-api/extraction)
- [Javascript Rendering](https://scrapfly.io/docs/scrape-api/javascript-rendering)
- [Javascript Scenario](https://scrapfly.io/docs/scrape-api/javascript-scenario)
- [SSL](https://scrapfly.io/docs/scrape-api/ssl)
- [DNS](https://scrapfly.io/docs/scrape-api/dns)
- [Cache](https://scrapfly.io/docs/scrape-api/cache)
- [Session](https://scrapfly.io/docs/scrape-api/session)
- [Webhook](https://scrapfly.io/docs/scrape-api/webhook)
- [Screenshot](https://scrapfly.io/docs/scrape-api/screenshot)
- [Errors](https://scrapfly.io/docs/scrape-api/errors)
- [Timeout](https://scrapfly.io/docs/scrape-api/understand-timeout)
- [Throttling](https://scrapfly.io/docs/throttling)
- [Troubleshoot](https://scrapfly.io/docs/scrape-api/troubleshoot)
- [Billing](https://scrapfly.io/docs/scrape-api/billing)
- [FAQ](https://scrapfly.io/docs/scrape-api/faq)

#### Crawler API

- [Getting Started](https://scrapfly.io/docs/crawler-api/getting-started)
- [API Specification]()
- [Retrieving Results](https://scrapfly.io/docs/crawler-api/results)
- [WARC Format](https://scrapfly.io/docs/crawler-api/warc-format)
- [Data Extraction](https://scrapfly.io/docs/crawler-api/extraction-rules)
- [Webhook](https://scrapfly.io/docs/crawler-api/webhook)
- [Billing](https://scrapfly.io/docs/crawler-api/billing)
- [Errors](https://scrapfly.io/docs/crawler-api/errors)
- [Troubleshoot](https://scrapfly.io/docs/crawler-api/troubleshoot)
- [FAQ](https://scrapfly.io/docs/crawler-api/faq)

#### Screenshot API

- [Getting Started](https://scrapfly.io/docs/screenshot-api/getting-started)
- [API Specification]()
- [Accessibility Testing](https://scrapfly.io/docs/screenshot-api/accessibility)
- [Webhook](https://scrapfly.io/docs/screenshot-api/webhook)
- [Billing](https://scrapfly.io/docs/screenshot-api/billing)
- [Errors](https://scrapfly.io/docs/screenshot-api/errors)

#### Extraction API

- [Getting Started](https://scrapfly.io/docs/extraction-api/getting-started)
- [API Specification]()
- [Rules Template](https://scrapfly.io/docs/extraction-api/rules-and-template)
- [LLM Extraction](https://scrapfly.io/docs/extraction-api/llm-prompt)
- [AI Auto Extraction](https://scrapfly.io/docs/extraction-api/automatic-ai)
- [Webhook](https://scrapfly.io/docs/extraction-api/webhook)
- [Billing](https://scrapfly.io/docs/extraction-api/billing)
- [Errors](https://scrapfly.io/docs/extraction-api/errors)
- [FAQ](https://scrapfly.io/docs/extraction-api/faq)

#### Proxy Saver

- [Getting Started](https://scrapfly.io/docs/proxy-saver/getting-started)
- [Fingerprints](https://scrapfly.io/docs/proxy-saver/fingerprints)
- [Optimizations](https://scrapfly.io/docs/proxy-saver/optimizations)
- [SSL Certificates](https://scrapfly.io/docs/proxy-saver/certificates)
- [Protocols](https://scrapfly.io/docs/proxy-saver/protocols)
- [Pacfile](https://scrapfly.io/docs/proxy-saver/pacfile)
- [Secure Credentials](https://scrapfly.io/docs/proxy-saver/security)
- [Billing](https://scrapfly.io/docs/proxy-saver/billing)

#### Cloud Browser API

- [Getting Started](https://scrapfly.io/docs/cloud-browser-api/getting-started)
- [Proxy & Geo-Targeting](https://scrapfly.io/docs/cloud-browser-api/proxy)
- [Unblock API](https://scrapfly.io/docs/cloud-browser-api/unblock)
- [File Downloads](https://scrapfly.io/docs/cloud-browser-api/file-downloads)
- [Session Resume](https://scrapfly.io/docs/cloud-browser-api/session-resume)
- [Human-in-the-Loop](https://scrapfly.io/docs/cloud-browser-api/human-in-the-loop)
- [Debug Mode](https://scrapfly.io/docs/cloud-browser-api/debug-mode)
- [Bring Your Own Proxy](https://scrapfly.io/docs/cloud-browser-api/bring-your-own-proxy)
- [Browser Extensions](https://scrapfly.io/docs/cloud-browser-api/extensions)
- [Native Browser MCP](https://scrapfly.io/docs/cloud-browser-api/mcp)
- [DevTools Protocol](https://scrapfly.io/docs/cloud-browser-api/cdp-reference)
##### Integrations

- [Puppeteer](https://scrapfly.io/docs/cloud-browser-api/puppeteer)
- [Playwright](https://scrapfly.io/docs/cloud-browser-api/playwright)
- [Selenium](https://scrapfly.io/docs/cloud-browser-api/selenium)
- [Vercel Agent Browser](https://scrapfly.io/docs/cloud-browser-api/agent-browser)
- [Browser Use](https://scrapfly.io/docs/cloud-browser-api/browser-use)
- [Stagehand](https://scrapfly.io/docs/cloud-browser-api/stagehand)

- [Billing](https://scrapfly.io/docs/cloud-browser-api/billing)
- [Errors](https://scrapfly.io/docs/cloud-browser-api/errors)


### Tools

- [Antibot Detector](https://scrapfly.io/docs/tools/antibot-detector)

### SDK

- [Golang](https://scrapfly.io/docs/sdk/golang)
- [Python](https://scrapfly.io/docs/sdk/python)
- [Rust](https://scrapfly.io/docs/sdk/rust)
- [TypeScript](https://scrapfly.io/docs/sdk/typescript)
- [Scrapy](https://scrapfly.io/docs/sdk/scrapy)

### Integrations

- [Getting Started](https://scrapfly.io/docs/integration/getting-started)
- [LangChain](https://scrapfly.io/docs/integration/langchain)
- [LlamaIndex](https://scrapfly.io/docs/integration/llamaindex)
- [CrewAI](https://scrapfly.io/docs/integration/crewai)
- [Zapier](https://scrapfly.io/docs/integration/zapier)
- [Make](https://scrapfly.io/docs/integration/make)
- [n8n](https://scrapfly.io/docs/integration/n8n)

### Academy

- [Overview](https://scrapfly.io/academy)
- [Web Scraping Overview](https://scrapfly.io/academy/scraping-overview)
- [Tools](https://scrapfly.io/academy/tools-overview)
- [Reverse Engineering](https://scrapfly.io/academy/reverse-engineering)
- [Static Scraping](https://scrapfly.io/academy/static-scraping)
- [HTML Parsing](https://scrapfly.io/academy/html-parsing)
- [Dynamic Scraping](https://scrapfly.io/academy/dynamic-scraping)
- [Hidden API Scraping](https://scrapfly.io/academy/hidden-api-scraping)
- [Headless Browsers](https://scrapfly.io/academy/headless-browsers)
- [Hidden Web Data](https://scrapfly.io/academy/hidden-web-data)
- [JSON Parsing](https://scrapfly.io/academy/json-parsing)
- [Data Processing](https://scrapfly.io/academy/data-processing)
- [Scaling](https://scrapfly.io/academy/scaling)
- [Walkthrough Summary](https://scrapfly.io/academy/walkthrough-summary)
- [Scraper Blocking](https://scrapfly.io/academy/scraper-blocking)
- [Proxies](https://scrapfly.io/academy/proxies)

---

 1. [DevTools Protocol](https://scrapfly.io/docs/cloud-browser-api/cdp-reference)
2. WebAuthn
 
  # WebAuthn

 Experimental 

This domain allows configuring virtual authenticators to test the WebAuthn API.

 - [Commands (13)](#commands)
- [Events (4)](#events)
- [Types (6)](#types)
 
   

No symbols match your filter.

## Commands

#### `WebAuthn.enable`

 

Enable the WebAuthn domain and start intercepting credential storage and
retrieval with a virtual authenticator.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `enableUI`  (optional) | `boolean` | Whether to enable the WebAuthn user interface. Enabling the UI is recommended for debugging and demo purposes, as it is closer to the real experience. Disabling the UI is recommended for automated testing. Supported at the embedder's discretion if UI is available. Defaults to false. |

 

 

 

#### `WebAuthn.disable`

 

Disable the WebAuthn domain.

 

 

#### `WebAuthn.addVirtualAuthenticator`

 

Creates and adds a virtual authenticator.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `options` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-VirtualAuthenticatorOptions">VirtualAuthenticatorOptions</a>` |  |

 

###### Return Object

 | Name | Type | Description |
|---|---|---|
| `authenticatorId` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-AuthenticatorId">AuthenticatorId</a>` |  |

 

 

 

#### `WebAuthn.setResponseOverrideBits`

 

Resets parameters isBogusSignature, isBadUV, isBadUP to false if they are not present.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `authenticatorId` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-AuthenticatorId">AuthenticatorId</a>` |  |
| `isBogusSignature`  (optional) | `boolean` | If isBogusSignature is set, overrides the signature in the authenticator response to be zero. Defaults to false. |
| `isBadUV`  (optional) | `boolean` | If isBadUV is set, overrides the UV bit in the flags in the authenticator response to be zero. Defaults to false. |
| `isBadUP`  (optional) | `boolean` | If isBadUP is set, overrides the UP bit in the flags in the authenticator response to be zero. Defaults to false. |

 

 

 

#### `WebAuthn.removeVirtualAuthenticator`

 

Removes the given authenticator.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `authenticatorId` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-AuthenticatorId">AuthenticatorId</a>` |  |

 

 

 

#### `WebAuthn.addCredential`

 

Adds the credential to the specified authenticator.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `authenticatorId` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-AuthenticatorId">AuthenticatorId</a>` |  |
| `credential` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-Credential">Credential</a>` |  |

 

 

 

#### `WebAuthn.getCredential`

 

Returns a single credential stored in the given virtual authenticator that
matches the credential ID.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `authenticatorId` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-AuthenticatorId">AuthenticatorId</a>` |  |
| `credentialId` | `binary` |  |

 

###### Return Object

 | Name | Type | Description |
|---|---|---|
| `credential` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-Credential">Credential</a>` |  |

 

 

 

#### `WebAuthn.getCredentials`

 

Returns all the credentials stored in the given virtual authenticator.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `authenticatorId` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-AuthenticatorId">AuthenticatorId</a>` |  |

 

###### Return Object

 | Name | Type | Description |
|---|---|---|
| `credentials` | `array<<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-Credential">Credential</a>>` |  |

 

 

 

#### `WebAuthn.removeCredential`

 

Removes a credential from the authenticator.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `authenticatorId` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-AuthenticatorId">AuthenticatorId</a>` |  |
| `credentialId` | `binary` |  |

 

 

 

#### `WebAuthn.clearCredentials`

 

Clears all the credentials from the specified device.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `authenticatorId` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-AuthenticatorId">AuthenticatorId</a>` |  |

 

 

 

#### `WebAuthn.setUserVerified`

 

Sets whether User Verification succeeds or fails for an authenticator.
The default is true.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `authenticatorId` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-AuthenticatorId">AuthenticatorId</a>` |  |
| `isUserVerified` | `boolean` |  |

 

 

 

#### `WebAuthn.setAutomaticPresenceSimulation`

 

Sets whether tests of user presence will succeed immediately (if true) or fail to resolve (if false) for an authenticator.
The default is true.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `authenticatorId` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-AuthenticatorId">AuthenticatorId</a>` |  |
| `enabled` | `boolean` |  |

 

 

 

#### `WebAuthn.setCredentialProperties`

 

Allows setting credential properties.
https://w3c.github.io/webauthn/#sctn-automation-set-credential-properties

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `authenticatorId` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-AuthenticatorId">AuthenticatorId</a>` |  |
| `credentialId` | `binary` |  |
| `backupEligibility`  (optional) | `boolean` |  |
| `backupState`  (optional) | `boolean` |  |

 

 

 

 

## Events

#### `WebAuthn.credentialAdded`

 

Triggered when a credential is added to an authenticator.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `authenticatorId` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-AuthenticatorId">AuthenticatorId</a>` |  |
| `credential` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-Credential">Credential</a>` |  |

 

 

 

#### `WebAuthn.credentialDeleted`

 

Triggered when a credential is deleted, e.g. through
PublicKeyCredential.signalUnknownCredential().

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `authenticatorId` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-AuthenticatorId">AuthenticatorId</a>` |  |
| `credentialId` | `binary` |  |

 

 

 

#### `WebAuthn.credentialUpdated`

 

Triggered when a credential is updated, e.g. through
PublicKeyCredential.signalCurrentUserDetails().

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `authenticatorId` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-AuthenticatorId">AuthenticatorId</a>` |  |
| `credential` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-Credential">Credential</a>` |  |

 

 

 

#### `WebAuthn.credentialAsserted`

 

Triggered when a credential is used in a webauthn assertion.

###### Parameters

 | Name | Type | Description |
|---|---|---|
| `authenticatorId` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-AuthenticatorId">AuthenticatorId</a>` |  |
| `credential` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-Credential">Credential</a>` |  |

 

 

 

 

## Types

#### `AuthenticatorId`

 (string) 

 

 

#### `AuthenticatorProtocol`

 (string) 

###### Allowed Values

- `u2f`
- `ctap2`
 
 

 

#### `Ctap2Version`

 (string) 

###### Allowed Values

- `ctap2_0`
- `ctap2_1`
 
 

 

#### `AuthenticatorTransport`

 (string) 

###### Allowed Values

- `usb`
- `nfc`
- `ble`
- `cable`
- `internal`
 
 

 

#### `VirtualAuthenticatorOptions`

 (object) 

###### Properties

 | Name | Type | Description |
|---|---|---|
| `protocol` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-AuthenticatorProtocol">AuthenticatorProtocol</a>` |  |
| `ctap2Version`  (optional) | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-Ctap2Version">Ctap2Version</a>` | Defaults to ctap2\_0. Ignored if \|protocol\| == u2f. |
| `transport` | `<a href="/docs/cloud-browser-api/cdp-reference/WebAuthn#type-AuthenticatorTransport">AuthenticatorTransport</a>` |  |
| `hasResidentKey`  (optional) | `boolean` | Defaults to false. |
| `hasUserVerification`  (optional) | `boolean` | Defaults to false. |
| `hasLargeBlob`  (optional) | `boolean` | If set to true, the authenticator will support the largeBlob extension. https://w3c.github.io/webauthn#largeBlob Defaults to false. |
| `hasCredBlob`  (optional) | `boolean` | If set to true, the authenticator will support the credBlob extension. https://fidoalliance.org/specs/fido-v2.1-rd-20201208/fido-client-to-authenticator-protocol-v2.1-rd-20201208.html#sctn-credBlob-extension Defaults to false. |
| `hasMinPinLength`  (optional) | `boolean` | If set to true, the authenticator will support the minPinLength extension. https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-20210615.html#sctn-minpinlength-extension Defaults to false. |
| `hasPrf`  (optional) | `boolean` | If set to true, the authenticator will support the prf extension. https://w3c.github.io/webauthn/#prf-extension Defaults to false. |
| `automaticPresenceSimulation`  (optional) | `boolean` | If set to true, tests of user presence will succeed immediately. Otherwise, they will not be resolved. Defaults to true. |
| `isUserVerified`  (optional) | `boolean` | Sets whether User Verification succeeds or fails for an authenticator. Defaults to false. |
| `defaultBackupEligibility`  (optional) | `boolean` | Credentials created by this authenticator will have the backup eligibility (BE) flag set to this value. Defaults to false. https://w3c.github.io/webauthn/#sctn-credential-backup |
| `defaultBackupState`  (optional) | `boolean` | Credentials created by this authenticator will have the backup state (BS) flag set to this value. Defaults to false. https://w3c.github.io/webauthn/#sctn-credential-backup |

 

 

 

#### `Credential`

 (object) 

###### Properties

 | Name | Type | Description |
|---|---|---|
| `credentialId` | `binary` |  |
| `isResidentCredential` | `boolean` |  |
| `rpId`  (optional) | `string` | Relying Party ID the credential is scoped to. Must be set when adding a credential. |
| `privateKey` | `binary` | The ECDSA P-256 private key in PKCS#8 format. |
| `userHandle`  (optional) | `binary` | An opaque byte sequence with a maximum size of 64 bytes mapping the credential to a specific user. |
| `signCount` | `integer` | Signature counter. This is incremented by one for each successful assertion. See https://w3c.github.io/webauthn/#signature-counter |
| `largeBlob`  (optional) | `binary` | The large blob associated with the credential. See https://w3c.github.io/webauthn/#sctn-large-blob-extension |
| `backupEligibility`  (optional) | `boolean` | Assertions returned by this credential will have the backup eligibility (BE) flag set to this value. Defaults to the authenticator's defaultBackupEligibility value. |
| `backupState`  (optional) | `boolean` | Assertions returned by this credential will have the backup state (BS) flag set to this value. Defaults to the authenticator's defaultBackupState value. |
| `userName`  (optional) | `string` | The credential's user.name property. Equivalent to empty if not set. https://w3c.github.io/webauthn/#dom-publickeycredentialentity-name |
| `userDisplayName`  (optional) | `string` | The credential's user.displayName property. Equivalent to empty if not set. https://w3c.github.io/webauthn/#dom-publickeycredentialuserentity-displayname |