browser.removeUserContext command

Syntax

{
  "method": "browser.removeUserContext",
  "params": {
    "userContext": "<userContextId>"
  }
}

Parameters

The params field contains:

userContext

A string that specifies the ID of the user context to remove. The default user context ("default") cannot be removed.

Return value

The result field in the response is an empty object ({}).

Errors

invalid argument

The userContext field is "default". The default user context cannot be removed.

no such user context

No user context with the given user context ID is found.

Examples

Removing a user context

Consider a scenario where you have a WebDriver BiDi connection and an active session. After creating a user context with browser.createUserContext, send the following message if you want to remove it:

{
  "id": 1,
  "method": "browser.removeUserContext",
  "params": {
    "userContext": "4e4b1f6d-3f1a-4b2e-9f8c-1a2b3c4d5e6f"
  }
}

The browser responds with a successful removal as follows:

{
  "id": 1,
  "type": "success",
  "result": {}
}

Specifications

Browser compatibility

See also

• session.new command
• browser.createUserContext command
• browser.getUserContexts command
• browser.close command
• session.end command