1. Context IDs

Manage custom Context IDs

A custom Context ID is a user-created identifier that, like a scoped Context ID, enables access to multiple resources such as content delivery and event ingestion, but is tailored to specific integration or deployment scenarios.

Note

To manage custom Context IDs, you must be an Organization Admin or Organization Owner in your Sitecore Cloud Portal organization.

Create a custom Context ID

To create a custom Context ID:

  1. Open the Context IDs page in the organization.

  2. In the upper right corner, click Create Context ID.

  3. In the Create Context ID dialog, in the Name and Description (optional) fields, enter a name and a description for your Context ID.

  4. To add resources for the custom Context ID, click Add resource, then click on the resource you want to add.

  5. For the resource added, in the Environment drop-down menu, click the relevant environment.

  6. Click Save.

  7. Optionally, to add Sitecore Search as a resource after creation of a content, go to the Context ID page, and click Add Search resource. In the Add Search resource dialog, enter the following information (available hovering over the tenant name in Sitecore Search), then click Add:

    • Domain ID - Enter the Domain ID from Sitecore Search.

    • Region - Enter the region of your Sitecore Search tenant.

    • API key - To view your Sitecore Search API key, in Sitecore Search, click Developer Resources > API Access, and create a new API key with a discover scope, dedicated for this custom Context ID with a proper description.

    • Search tenant - This field is prefilled with your Sitecore Search tenant name.

  8. Optionally, to sync your custom ID with the Master Context IDs, on the Context ID page, click Menu > Sync with Master Context ID.

    Note

    • When synchronized with master, the Context ID inherits updates when the master Context ID changes. This option is suitable when you want consistency with the default configuration

    • When not synchronized with master, the Context ID remains independent, and you control its resources explicitly. This option is recommended when creating tightly scoped Context IDs for specific use cases, such as standalone Sitecore Search integrations. Because custom Context IDs should be scoped, choosing not to synchronize gives you full control over resource access and helps enforce stricter security boundaries.

We recommend to not use the custom Context ID themselves, but to create scoped contexts to be used in your applications. When doing so, remember to create 2 scoped Context IDs: a serverside one (Live) and a clientside one (Preview).

Edit a custom Context ID

You can edit the name of a custom Context ID.

To edit a custom Context ID:

  1. On the Context IDs page, click the custom Context ID that you want to edit.

  2. On the Context ID page, click Actions > Edit.

  3. In the Edit Context ID dialog, make your desired changes, then click Save.

Delete a custom Context ID

To edit a custom Context ID:

  1. On the Context IDs page, click the custom Context ID that you want to edit.

  2. On the Context ID page, click Actions > Delete.

  3. In the Delete scoped context dialog, enter delete, then click Delete.

If you have suggestions for improving this article, let us know!