contextualIdentities.create()

Creates a new contextual identity. Once created, the user will be able to create new tabs belonging to this contextual identity, just as they can with the built-in identities.

This is an asynchronous function that returns a Promise.

Syntax

var createContext = browser.contextualIdentities.create(
  details                  // object
)

Parameters

details

object. An object containing properties for the new contextual identity. This contains the following properties:

name

string. The name of the new identity. This will be displayed in the browser's UI, enabling them to open a new tab belonging to the identity. It will also be displayed in the URL bar for tabs belonging to this identity.

color

string. The color associated with the new identity. This will be used to highlight tabs belonging to this identity. You can supply any of the following values here:

  • "blue"
  • "turquoise"
  • "green"
  • "yellow"
  • "orange"
  • "red"
  • "pink"
  • "purple" 
icon

string. The name of an icon to display in the URL bar for tabs belonging to this identity. You can supply any of the following values here:

  • "fingerprint"
  • "briefcase"
  • "dollar"
  • "cart"
  • "circle"
  • "gift"
  • "vacation"
  • "food"
  • "fruit"
  • "pet"
  • "tree"
  • "chill"

Return value

A Promise that will be fulfilled with a ContextualIdentity that describes the new identity. If the contextual identities feature is not enabled, the promise is rejected.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
Basic supportChrome No support NoEdge No support NoFirefox Full support 53
Notes
Full support 53
Notes
Notes Before version 57, this method resolves its promise with false if the contextual identities feature is disabled.
Opera No support NoFirefox Android Full support 53
Notes
Full support 53
Notes
Notes Before version 57, this method resolves its promise with false if the contextual identities feature is disabled.

Legend

Full support  
Full support
No support  
No support
See implementation notes.
See implementation notes.

Examples

This example creates a new contextual identity and logs its cookie store ID:

function onCreated(context) {
  console.log(`New identity's ID: ${context.cookieStoreId}.`);
}

function onError(e) {
  console.error(e);
}

browser.contextualIdentities.create({
  name: "my-thing",
  color: "purple",
  icon: "briefcase"
}).then(onCreated, onError);

Document Tags and Contributors

Contributors to this page: Fayne_Aldan, wbamberg
Last updated by: Fayne_Aldan,