Manage Context IDs

A Context ID enables your application to access your organization's resources such as Personalize, CDP, and Experience Edge. When you create a SitecoreAI environment, two Context IDs are created automatically to simplify set up and configuration, but you can create additional scoped Context IDs to grant access to specific resources.

Before you begin

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

Create a scoped Context ID

A scoped Context ID is a child of a Context ID and grants access to a subset of the parent Context ID's resources. When creating a scoped Context ID, you still specify which resources it will grant access to, but can only select resources that have been added to the parent Context ID.

Scoped Context IDs allow you to assign more granular, customized access to a Context ID's resources.

To create a scoped Context ID:

  1. Open the Context IDs page in the organization where you want to create a scoped Context ID.

  2. On the Context IDs page, click the Context ID where you want to create a scoped Context ID.

  3. On the Context ID page, click Create scoped Context ID.

  4. In the Create scoped Context ID dialog, select the resources that you want to add to the scoped Context ID:

    Note

    Some resources have dependencies on other resources. When you select a resource with dependencies, its required resources are automatically selected.

    • 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.

    • Forms - grants access to the Forms app of a SitecoreAI environment.

    • Files - grants access to files that are needed for the Component builder, Design studio, and other key features.

    • Edge - grants access to either the Experience Edge Delivery API (Live) or the Preview API (Preview) of a SitecoreAI environment.

    • Site Analytics (identifier) - grants access to the analytics identifier of a site.

  5. Optionally, in the Name (optional) field, enter a name for your Context ID.

  6. Click Save.

Now you can use the new scoped Context ID with your app, service, or SDK.

Edit a scoped Context ID

You can edit the resources and name of a scoped Context ID.

To edit a scoped Context ID:

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

  2. On the Context ID page, locate the scoped Context ID you want to edit, then click Actions > Edit.

  3. In the Edit scoped context dialog, make your desired changes, then click Save.

Delete a scoped Context ID

Note

You cannot delete Context IDs that were automatically generated when your SitecoreAI environment was created (these Context IDs have the Master tag), but you can regenerate them in the Sitecore AI Deploy app.

To delete a scoped Context ID:

  1. On the Context IDs page, click the Context ID that contains the scoped Context ID you want to delete.

  2. On the Context ID page, locate the scoped Context ID you want to delete, then click Actions > Delete.

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

Do you have some feedback for us?

If you have suggestions for improving this article,