Context IDs
To manage the Context IDs of an organization, you need the Organization Admin or Organization Owner role.
A Context ID is a unified identifier that grants access to specific resources in a Sitecore Cloud Portal organization, making it easier to set up and configure Sitecore solutions. It functions like a collection of keys that your apps and services can use to access your organization's resources such as CDP, Personalize, and Experience Edge.
Some code examples, images, and UI labels may still use XM Cloud while engineering assets are being updated.
Context IDs enable you to do the following:
-
Improve security and assign granular access by creating scoped Context IDs that only grant access to the resources required by a specific app or service.
-
Create separate scoped Context IDs for client and server code to limit sensitive API access to server-side operations.
There are two types of Context IDs:
-
Context IDs that are automatically generated when you create a SitecoreAI environment - the Live Context ID and Preview Context ID. You can regenerate these Context IDs from the SitecoreAI Deploy app. These Context IDs come preconfigured with the resources required for SitecoreAI to work properly. In the Context IDs page, they have the Master tag. You can regenerate these Context IDs from the Deploy app, but not modify them in any other way.
-
Scoped Context IDs created under an existing Context ID. A hierarchy of scoped Context IDs enables customizable access to the resources of parent Context IDs, making it possible to precisely manage access to your resources. Each scoped Context ID can inherit resources from its parent only. If you modify or delete a resource in the primary Context ID, all scoped Context IDs that grant the resource are affected.
You manage your organization's scoped Context IDs from the Sitecore Cloud Portal.
Resources
When you create scoped Context ID, you select the resources that it will provide access to. A resource contains credentials and information that let you access a Sitecore resource. If a Context ID is a keychain, then a resource is a key on that chain.
You can add various types of resources to a Context ID, such as Personalize and Edge. Most of these types are limited to one per Context ID. The exception is the Site identifier resource, which you can assign multiple times if your SitecoreAI environment has multiple sites.
You can add the following resources to a Context ID:
-
Personalize- grants access to a Personalize instance. If you have CDP in your Sitecore Cloud Portal organization, it also grants access to the associated CDP instance. -
Edge- grants access to either the Experience Edge Delivery API (Live) or the Preview API (Preview) of a SitecoreAI environment. -
Files- grants access to files that are needed for the Component builder, Design studio, and other key features. -
Forms- grants access to the Forms app of a SitecoreAI environment. -
Site Analytics (identifier)- grants access to the analytics identifier of a site.