{"items":[{"type":"link","label":"Edge Platform Custom Context API","link":"/portal/edge-platform-custom-context-api","routeSlug":"/portal/edge-platform-custom-context-api","content":{"contentType":"overview","meta":{"name":"Edge Platform Custom Context API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/portal/edge-platform-custom-context-api/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/portal/edge-platform-custom-context-api/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Edge Platform Custom Context API (1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Custom Context API to create, retrieve, update, and delete the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/portal/en/developers/sitecore-cloud-portal/context-ids.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"context"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A context ID is a unified identifier that grants access to specific resources in a Sitecore Cloud Portal organization and is helps determine the context for an organization."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this REST API, you must authenticate your API requests. Keep in mind:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All API requests are made in your production environment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The base URL is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://edge-platform-context-api.sitecorecloud.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": You must have an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/portal/en/developers/sitecore-cloud-portal/roles.html#organization-roles"},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization Admin"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization Owner"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in Sitecore Cloud Portal."},"children":[]}]}]}]}],"sectionId":"/portal/edge-platform-custom-context-api"}],"sectionId":"/portal/edge-platform-custom-context-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Edge Platform Context API uses "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/portal/en/developers/sitecore-cloud-portal/manage-api-tokens.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" authentication. Bearer tokens are generated in response to a login request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a bearer token:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://portal.sitecorecloud.io/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sitecore Cloud Portal"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the top-right corner of the menu bar, click your profile icon > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API tokens"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Copy to clipboard"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can now start making REST API requests. You must include this token in the authorization header of every request you make."},"children":[]}]}]}]}],"sectionId":"/portal/edge-platform-custom-context-api/section/authentication"}]}]}},{"type":"link","label":"Authentication","link":"/portal/edge-platform-custom-context-api/section/authentication","routeSlug":"/portal/edge-platform-custom-context-api/section/authentication","content":null},{"type":"group","label":"Context","link":"/portal/edge-platform-custom-context-api/context","routeSlug":"/portal/edge-platform-custom-context-api/context","items":[{"label":"Create context","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal/edge-platform-custom-context-api/context/createusercontext","routeSlug":"/portal/edge-platform-custom-context-api/context/createusercontext","metadata":{"seo":{"title":"Create context","description":"Create a context within your organization. Creating a context means issuing a new context ID and defining what it can access."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateUserContext","name":"Create context","isWebhook":false,"pointer":"/paths/~1api~1context~1user~1v1~1contexts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create context","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a context within your organization. Creating a context means issuing a new context ID and defining what it can access."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be present together."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1288"}},"schemaId":"schema_1288","pointer":"/paths/~1api~1context~1user~1v1~1contexts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/context/user/v1/contexts","servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1288"}},"responseCodes":["201","401","409","422","500"],"pointer":"/api/context/user/v1/contexts","href":"context/createusercontext","openApiOperationId":"CreateUserContext","summary":"Create context"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"schemaId":"schema_1288","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1288"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1289"}},"schemaId":"schema_1289"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"422","description":"Unprocessable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_1289","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1289"}}},{"code":"401","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"409","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"422","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"500","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/context/createusercontext"}],"panels":[]}]},"httpPath":"/api/context/user/v1/contexts"},{"label":"Retrieve a context by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal/edge-platform-custom-context-api/context/getusercontextbyid","routeSlug":"/portal/edge-platform-custom-context-api/context/getusercontextbyid","metadata":{"seo":{"title":"Retrieve a context by ID","description":"Get a context within your organization by specifying a sitecoreContextId . When you get a context, you retrieve the configuration and metadata of the context. This tells you what the context ID grants access to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetUserContextById","name":"Retrieve a context by ID","isWebhook":false,"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a context by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a context within your organization by specifying a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sitecoreContextId "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When you get a context, you retrieve the configuration and metadata of the context. This tells you what the context ID grants access to."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"sitecoreContextId","in":"path","schemaId":"schema_1291","description":"Sitecore Context ID","required":true}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/context/user/v1/contexts/{sitecoreContextId}","servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"parameters":{"path":[{"name":"sitecoreContextId","in":"path","required":true,"example":"f9c3b17d181640efbbf3ae670311452d","schemaId":"schema_1291"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/api/context/user/v1/contexts/{sitecoreContextId}","href":"context/getusercontextbyid","openApiOperationId":"GetUserContextById","summary":"Retrieve a context by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1289"}},"schemaId":"schema_1289"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1289","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1289"}}},{"code":"401","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"404","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"500","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/context/getusercontextbyid"}],"panels":[]}]},"httpPath":"/api/context/user/v1/contexts/{sitecoreContextId}"},{"label":"Delete a context by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal/edge-platform-custom-context-api/context/deleteusercontextbyid","routeSlug":"/portal/edge-platform-custom-context-api/context/deleteusercontextbyid","metadata":{"seo":{"title":"Delete a context by ID","description":"Delete a context within an organization by specifying a sitecoreContextId . When you delete a context, the context no longer grants access."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteUserContextById","name":"Delete a context by ID","isWebhook":false,"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a context by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a context within an organization by specifying a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sitecoreContextId "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When you delete a context, the context no longer grants access."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"sitecoreContextId","in":"path","schemaId":"schema_1292","description":"Sitecore Context Id","required":true}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/context/user/v1/contexts/{sitecoreContextId}","servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"parameters":{"path":[{"name":"sitecoreContextId","in":"path","required":true,"example":"f9c3b17d181640efbbf3ae670311452d","schemaId":"schema_1292"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","400","401","404","412","500"],"pointer":"/api/context/user/v1/contexts/{sitecoreContextId}","href":"context/deleteusercontextbyid","openApiOperationId":"DeleteUserContextById","summary":"Delete a context by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Request not valid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"412","description":"Precondition Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"401","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"404","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"412","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"500","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/context/deleteusercontextbyid"}],"panels":[]}]},"httpPath":"/api/context/user/v1/contexts/{sitecoreContextId}"},{"label":"Update a context","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal/edge-platform-custom-context-api/context/updateusercontext","routeSlug":"/portal/edge-platform-custom-context-api/context/updateusercontext","metadata":{"seo":{"title":"Update a context","description":"Update a context by specifying a sitecoreContextId. Updating a context, you update the context definition without creating a new context (for example, you can adjust the access time."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateUserContext","name":"Update a context","isWebhook":false,"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a context","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a context by specifying a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sitecoreContextId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Updating a context, you update the context definition without creating a new context (for example, you can adjust the access time."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"sitecoreContextId","in":"path","schemaId":"schema_1291","description":"Sitecore Context ID","required":true}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1293"}},"schemaId":"schema_1293","pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/context/user/v1/contexts/{sitecoreContextId}","servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"parameters":{"path":[{"name":"sitecoreContextId","in":"path","required":true,"example":"f9c3b17d181640efbbf3ae670311452d","schemaId":"schema_1291"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1293"}},"responseCodes":["202","401","404","412","422","500"],"pointer":"/api/context/user/v1/contexts/{sitecoreContextId}","href":"context/updateusercontext","openApiOperationId":"UpdateUserContext","summary":"Update a context"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"schemaId":"schema_1293","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1293"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1289"}},"schemaId":"schema_1289"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"412","description":"Precondition Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"422","description":"Unprocessable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"schema_1289","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1289"}}},{"code":"401","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"404","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"412","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"422","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"500","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/context/updateusercontext"}],"panels":[]}]},"httpPath":"/api/context/user/v1/contexts/{sitecoreContextId}"},{"label":"Regenerate a custom context ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal/edge-platform-custom-context-api/context/regenerateusercontextid","routeSlug":"/portal/edge-platform-custom-context-api/context/regenerateusercontextid","metadata":{"seo":{"title":"Regenerate a custom context ID","description":"Update a custom context ID by specifying a sitecoreContextId. When you regenerate a custom context ID, this means replacing the SitecoreContextId value with a new one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RegenerateUserContextId","name":"Regenerate a custom context ID","isWebhook":false,"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}~1regenerate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Regenerate a custom context ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a custom context ID by specifying a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sitecoreContextId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When you regenerate a custom context ID, this means replacing the SitecoreContextId value with a new one."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"sitecoreContextId","in":"path","schemaId":"schema_1291","description":"Sitecore Context ID","required":true}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}~1regenerate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/context/user/v1/contexts/{sitecoreContextId}/regenerate","servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"parameters":{"path":[{"name":"sitecoreContextId","in":"path","required":true,"example":"f9c3b17d181640efbbf3ae670311452d","schemaId":"schema_1291"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["202","401","403","404","500"],"pointer":"/api/context/user/v1/contexts/{sitecoreContextId}/regenerate","href":"context/regenerateusercontextid","openApiOperationId":"RegenerateUserContextId","summary":"Regenerate a custom context ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1289"}},"schemaId":"schema_1289"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request does not contain required scopes (expected any of: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ep.usr.ctx:w"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}~1regenerate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"schema_1289","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1289"}}},{"code":"401","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"403","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"404","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"500","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/context/regenerateusercontextid"}],"panels":[]}]},"httpPath":"/api/context/user/v1/contexts/{sitecoreContextId}/regenerate"},{"label":"List custom-context pagination","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal/edge-platform-custom-context-api/context/listusercontextpagination","routeSlug":"/portal/edge-platform-custom-context-api/context/listusercontextpagination","metadata":{"seo":{"title":"List custom-context pagination","description":"Retrieve a paginated list of contexts within an organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListUserContextPagination","name":"List custom-context pagination","isWebhook":false,"pointer":"/paths/~1api~1context~1user~1v2~1contexts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List custom-context pagination","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a paginated list of contexts within an organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"onlyId","in":"query","schemaId":"schema_1294","description":"Returns IDs only"},{"name":"pageSize","in":"query","schemaId":"schema_1295"},{"name":"pageNumber","in":"query","schemaId":"schema_1296"}],"pointer":"/paths/~1api~1context~1user~1v2~1contexts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/context/user/v2/contexts","servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"parameters":{"path":[],"query":[{"name":"onlyId","in":"query","required":false,"example":"false","schemaId":"schema_1294"},{"name":"pageSize","in":"query","required":false,"example":10,"schemaId":"schema_1295"},{"name":"pageNumber","in":"query","required":false,"example":1,"schemaId":"schema_1296"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/context/user/v2/contexts","href":"context/listusercontextpagination","openApiOperationId":"ListUserContextPagination","summary":"List custom-context pagination"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1297"}},"schemaId":"schema_1297"},{"code":"400","description":"Request not valid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"}],"pointer":"/paths/~1api~1context~1user~1v2~1contexts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1297","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1297"}}},{"code":"400","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"401","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"500","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/context/listusercontextpagination"}],"panels":[]}]},"httpPath":"/api/context/user/v2/contexts"}],"content":{"contentType":"group","meta":{"name":"Context"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Context","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Context API lets you "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/portal/en/developers/sitecore-cloud-portal/context-ids.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create and manage context IDs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for your organization."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/context/user/v1/contexts","summary":"Create context","prefix":{"name":"post","color":"post"},"badges":[],"link":"/context/createusercontext","deprecated":false},{"title":"/api/context/user/v1/contexts/{sitecoreContextId}","summary":"Retrieve a context by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/context/getusercontextbyid","deprecated":false},{"title":"/api/context/user/v1/contexts/{sitecoreContextId}","summary":"Delete a context by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/context/deleteusercontextbyid","deprecated":false},{"title":"/api/context/user/v1/contexts/{sitecoreContextId}","summary":"Update a context","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/context/updateusercontext","deprecated":false},{"title":"/api/context/user/v1/contexts/{sitecoreContextId}/regenerate","summary":"Regenerate a custom context ID","prefix":{"name":"post","color":"post"},"badges":[],"link":"/context/regenerateusercontextid","deprecated":false},{"title":"/api/context/user/v2/contexts","summary":"List custom-context pagination","prefix":{"name":"get","color":"get"},"badges":[],"link":"/context/listusercontextpagination","deprecated":false}]}]}]}]}},{"type":"group","label":"Resources","link":"/portal/edge-platform-custom-context-api/resources","routeSlug":"/portal/edge-platform-custom-context-api/resources","items":[{"label":"Create resources","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal/edge-platform-custom-context-api/resources/createuserresource","routeSlug":"/portal/edge-platform-custom-context-api/resources/createuserresource","metadata":{"seo":{"title":"Create resources","description":"Create a context resource. This means adding a specific access target, such as Edge, Personalize, and so on, to an existing context ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateUserResource","name":"Create resources","isWebhook":false,"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}~1resources/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create resources","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a context resource. This means adding a specific access target, such as Edge, Personalize, and so on, to an existing context ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"sitecoreContextId","in":"path","schemaId":"schema_1291","description":"Sitecore Context ID","required":true}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}~1resources/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1298"}},"schemaId":"schema_1298","pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}~1resources/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/context/user/v1/contexts/{sitecoreContextId}/resources","servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"parameters":{"path":[{"name":"sitecoreContextId","in":"path","required":true,"example":"f9c3b17d181640efbbf3ae670311452d","schemaId":"schema_1291"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1298"}},"responseCodes":["201","401","404","409","422","500"],"pointer":"/api/context/user/v1/contexts/{sitecoreContextId}/resources","href":"resources/createuserresource","openApiOperationId":"CreateUserResource","summary":"Create resources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"schemaId":"schema_1298","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1298"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1299"}},"schemaId":"schema_1299"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"422","description":"Unprocessable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}~1resources/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_1299","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1299"}}},{"code":"401","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"404","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"409","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"422","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"500","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/resources/createuserresource"}],"panels":[]}]},"httpPath":"/api/context/user/v1/contexts/{sitecoreContextId}/resources"},{"label":"List resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal/edge-platform-custom-context-api/resources/listuserresource","routeSlug":"/portal/edge-platform-custom-context-api/resources/listuserresource","metadata":{"seo":{"title":"List resources","description":"Lists all resources attached to a specific context. This is useful when you want to determine what that context can access."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListUserResource","name":"List resources","isWebhook":false,"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}~1resources/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List resources","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all resources attached to a specific context. This is useful when you want to determine what that context can access."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"sitecoreContextId","in":"path","schemaId":"schema_1291","description":"Sitecore Context ID","required":true}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}~1resources/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/context/user/v1/contexts/{sitecoreContextId}/resources","servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"parameters":{"path":[{"name":"sitecoreContextId","in":"path","required":true,"example":"f9c3b17d181640efbbf3ae670311452d","schemaId":"schema_1291"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/context/user/v1/contexts/{sitecoreContextId}/resources","href":"resources/listuserresource","openApiOperationId":"ListUserResource","summary":"List resources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1300"}},"schemaId":"schema_1300"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}~1resources/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1300","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1300"}}},{"code":"401","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"500","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/resources/listuserresource"}],"panels":[]}]},"httpPath":"/api/context/user/v1/contexts/{sitecoreContextId}/resources"},{"label":"Retrieve a context resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal/edge-platform-custom-context-api/resources/getuserresource","routeSlug":"/portal/edge-platform-custom-context-api/resources/getuserresource","metadata":{"seo":{"title":"Retrieve a context resource","description":"Get a context' resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetUserResource","name":"Retrieve a context resource","isWebhook":false,"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}~1resources~1{resourceId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a context resource","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a context' resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"sitecoreContextId","in":"path","schemaId":"schema_1291","description":"Sitecore Context ID","required":true},{"name":"resourceId","in":"path","schemaId":"schema_1301","description":"Resource Id","required":true}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}~1resources~1{resourceId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/context/user/v1/contexts/{sitecoreContextId}/resources/{resourceId}","servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"parameters":{"path":[{"name":"sitecoreContextId","in":"path","required":true,"example":"f9c3b17d181640efbbf3ae670311452d","schemaId":"schema_1291"},{"name":"resourceId","in":"path","required":true,"example":"SitecorePesonalizeResource","schemaId":"schema_1301"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/api/context/user/v1/contexts/{sitecoreContextId}/resources/{resourceId}","href":"resources/getuserresource","openApiOperationId":"GetUserResource","summary":"Retrieve a context resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1302"}},"schemaId":"schema_1302"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}~1resources~1{resourceId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1302","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1302"}}},{"code":"401","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"404","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"500","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/resources/getuserresource"}],"panels":[]}]},"httpPath":"/api/context/user/v1/contexts/{sitecoreContextId}/resources/{resourceId}"},{"label":"List resources available in the organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal/edge-platform-custom-context-api/resources/listuseravailableresource","routeSlug":"/portal/edge-platform-custom-context-api/resources/listuseravailableresource","metadata":{"seo":{"title":"List resources available in the organization","description":"Lists all available resources of the user's organization that can be added to a context."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListUserAvailableResource","name":"List resources available in the organization","isWebhook":false,"pointer":"/paths/~1api~1context~1user~1v1~1available-resources/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List resources available in the organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all available resources of the user's organization that can be added to a context."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_1303","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"personalize | edge | search | forms | files"},"children":[]}]}]}]}],"pointer":"/paths/~1api~1context~1user~1v1~1available-resources/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/context/user/v1/available-resources","servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"parameters":{"path":[],"query":[{"name":"type","in":"query","required":false,"example":"personalize","schemaId":"schema_1303"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/api/context/user/v1/available-resources","href":"resources/listuseravailableresource","openApiOperationId":"ListUserAvailableResource","summary":"List resources available in the organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1304"}},"schemaId":"schema_1304"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"}],"pointer":"/paths/~1api~1context~1user~1v1~1available-resources/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1304","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1304"}}},{"code":"401","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"500","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/resources/listuseravailableresource"}],"panels":[]}]},"httpPath":"/api/context/user/v1/available-resources"}],"content":{"contentType":"group","meta":{"name":"Resources"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resources","showPageActions":true},{"nodeType":"markdoc","content":"The Resource API lets you create and manage context resources in your organization (for example, add a key, list keys, or fetch a key)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/context/user/v1/contexts/{sitecoreContextId}/resources","summary":"Create resources","prefix":{"name":"post","color":"post"},"badges":[],"link":"/resources/createuserresource","deprecated":false},{"title":"/api/context/user/v1/contexts/{sitecoreContextId}/resources","summary":"List resources","prefix":{"name":"get","color":"get"},"badges":[],"link":"/resources/listuserresource","deprecated":false},{"title":"/api/context/user/v1/contexts/{sitecoreContextId}/resources/{resourceId}","summary":"Retrieve a context resource","prefix":{"name":"get","color":"get"},"badges":[],"link":"/resources/getuserresource","deprecated":false},{"title":"/api/context/user/v1/available-resources","summary":"List resources available in the organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/resources/listuseravailableresource","deprecated":false}]}]}]}]}},{"type":"group","label":"Scoped context","link":"/portal/edge-platform-custom-context-api/scoped-context","routeSlug":"/portal/edge-platform-custom-context-api/scoped-context","items":[{"label":"Create a scoped context","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal/edge-platform-custom-context-api/scoped-context/createuserfilteredcontext","routeSlug":"/portal/edge-platform-custom-context-api/scoped-context/createuserfilteredcontext","metadata":{"seo":{"title":"Create a scoped context","description":"Creates a scoped context for the masterSitecoreContextId within an organization. It defines subset access through the allowedResourceIds."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateUserFilteredContext","name":"Create a scoped context","isWebhook":false,"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{masterSitecoreContextId}~1filtered/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a scoped context","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a scoped context for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"masterSitecoreContextId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within an organization. It defines subset access through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowedResourceIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"masterSitecoreContextId","in":"path","schemaId":"schema_1305","description":"Sitecore Context ID of the master context","required":true}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{masterSitecoreContextId}~1filtered/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1306"}},"schemaId":"schema_1306","pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{masterSitecoreContextId}~1filtered/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered","servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"parameters":{"path":[{"name":"masterSitecoreContextId","in":"path","required":true,"example":"f9c3b17d181640efbbf3ae670311452d","schemaId":"schema_1305"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1306"}},"responseCodes":["201","400","401","403","404","409","422","500"],"pointer":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered","href":"scoped-context/createuserfilteredcontext","openApiOperationId":"CreateUserFilteredContext","summary":"Create a scoped context"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"schemaId":"schema_1306","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1306"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Scoped context successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1307"}},"schemaId":"schema_1307"},{"code":"400","description":"Invalid allowedResourceIds","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request does not contain required scopes (expected any of: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ep.usr.ctx:w"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"404","description":"Data not found by the provided organizationId or masterSitecoreContextId","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"409","description":"Data already exists by the provided sitecoreContextId","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"422","description":"Name at most 80 characters long","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{masterSitecoreContextId}~1filtered/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_1307","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1307"}}},{"code":"400","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"401","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"403","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"404","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"409","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"422","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"500","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scoped-context/createuserfilteredcontext"}],"panels":[]}]},"httpPath":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered"},{"label":"List scoped contexts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal/edge-platform-custom-context-api/scoped-context/listuserfilteredcontext","routeSlug":"/portal/edge-platform-custom-context-api/scoped-context/listuserfilteredcontext","metadata":{"seo":{"title":"List scoped contexts","description":"List all scoped contexts under a given parent (masterSitecoreContextId), including allowed resouces and metadata."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListUserFilteredContext","name":"List scoped contexts","isWebhook":false,"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{masterSitecoreContextId}~1filtered/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List scoped contexts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all scoped contexts under a given parent ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"masterSitecoreContextId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), including allowed resouces and metadata."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"masterSitecoreContextId","in":"path","schemaId":"schema_1305","description":"Sitecore Context ID of the master context","required":true}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{masterSitecoreContextId}~1filtered/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered","servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"parameters":{"path":[{"name":"masterSitecoreContextId","in":"path","required":true,"example":"f9c3b17d181640efbbf3ae670311452d","schemaId":"schema_1305"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered","href":"scoped-context/listuserfilteredcontext","openApiOperationId":"ListUserFilteredContext","summary":"List scoped contexts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List successfully retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1308"}},"schemaId":"schema_1308"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request does not contain required scopes (expected any of: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ep.usr.ctx:r"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"404","description":"Data not found by the provided organizationId or masterSitecoreContextId","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{masterSitecoreContextId}~1filtered/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1308","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1308"}}},{"code":"401","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"403","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"404","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"500","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scoped-context/listuserfilteredcontext"}],"panels":[]}]},"httpPath":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered"},{"label":"Update a scoped context","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal/edge-platform-custom-context-api/scoped-context/updateuserfilteredcontext","routeSlug":"/portal/edge-platform-custom-context-api/scoped-context/updateuserfilteredcontext","metadata":{"seo":{"title":"Update a scoped context","description":"Updates a scoped context for a masterSitecoreContextId and sitecoreContextId within an organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateUserFilteredContext","name":"Update a scoped context","isWebhook":false,"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{masterSitecoreContextId}~1filtered~1{sitecoreContextId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a scoped context","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a scoped context for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"masterSitecoreContextId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sitecoreContextId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within an organization."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"masterSitecoreContextId","in":"path","schemaId":"schema_1305","description":"Sitecore context ID of the master context","required":true},{"name":"sitecoreContextId","in":"path","schemaId":"schema_1309","required":true}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{masterSitecoreContextId}~1filtered~1{sitecoreContextId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1310"}},"schemaId":"schema_1310","pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{masterSitecoreContextId}~1filtered~1{sitecoreContextId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered/{sitecoreContextId}","servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"parameters":{"path":[{"name":"masterSitecoreContextId","in":"path","required":true,"example":"f9c3b17d181640efbbf3ae670311452d","schemaId":"schema_1305"},{"name":"sitecoreContextId","in":"path","required":true,"example":"fcb58fa476ebcc9df896d8e8608a718b","schemaId":"schema_1309"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1310"}},"responseCodes":["202","400","401","403","404","422","500"],"pointer":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered/{sitecoreContextId}","href":"scoped-context/updateuserfilteredcontext","openApiOperationId":"UpdateUserFilteredContext","summary":"Update a scoped context"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"schemaId":"schema_1310","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1310"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Scoped context successfully updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1311"}},"schemaId":"schema_1311"},{"code":"400","description":"Invalid allowedResourceIds","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request does not contain required scopes (expected any of: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ep.usr.ctx:w"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"404","description":"Data not found by the provided organizationId or masterSitecoreContextId or sitecoreContextId","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"422","description":"Name - max 80 characters long","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{masterSitecoreContextId}~1filtered~1{sitecoreContextId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"schema_1311","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1311"}}},{"code":"400","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"401","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"403","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"404","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"422","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"500","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scoped-context/updateuserfilteredcontext"}],"panels":[]}]},"httpPath":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered/{sitecoreContextId}"},{"label":"Delete scoped context","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal/edge-platform-custom-context-api/scoped-context/deleteuserfilteredcontext","routeSlug":"/portal/edge-platform-custom-context-api/scoped-context/deleteuserfilteredcontext","metadata":{"seo":{"title":"Delete scoped context","description":"Deletes the scoped context identified by masterSitecoreContextId and sitecoreContextId when it's no longer needed. This revokes access granted through that scoped context to its allowed allowedResourceIds."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteUserFilteredContext","name":"Delete scoped context","isWebhook":false,"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{masterSitecoreContextId}~1filtered~1{sitecoreContextId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete scoped context","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes the scoped context identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"masterSitecoreContextId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sitecoreContextId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when it's no longer needed. This revokes access granted through that scoped context to its allowed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowedResourceIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"masterSitecoreContextId","in":"path","schemaId":"schema_1305","description":"Sitecore Context ID of the master context","required":true},{"name":"sitecoreContextId","in":"path","schemaId":"schema_1309","required":true}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{masterSitecoreContextId}~1filtered~1{sitecoreContextId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered/{sitecoreContextId}","servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"parameters":{"path":[{"name":"masterSitecoreContextId","in":"path","required":true,"example":"f9c3b17d181640efbbf3ae670311452d","schemaId":"schema_1305"},{"name":"sitecoreContextId","in":"path","required":true,"example":"fcb58fa476ebcc9df896d8e8608a718b","schemaId":"schema_1309"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","403","404","500"],"pointer":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered/{sitecoreContextId}","href":"scoped-context/deleteuserfilteredcontext","openApiOperationId":"DeleteUserFilteredContext","summary":"Delete scoped context"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Scoped context successfully deleted"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request does not contain required scopes (expected any of: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ep.usr.ctx:w"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"404","description":"Data not found by the provided organizationId or masterSitecoreContextId or sitecoreContextId","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{masterSitecoreContextId}~1filtered~1{sitecoreContextId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"403","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"404","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"500","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scoped-context/deleteuserfilteredcontext"}],"panels":[]}]},"httpPath":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered/{sitecoreContextId}"},{"label":"Retrieve scoped context data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal/edge-platform-custom-context-api/scoped-context/getuserfilteredcontext","routeSlug":"/portal/edge-platform-custom-context-api/scoped-context/getuserfilteredcontext","metadata":{"seo":{"title":"Retrieve scoped context data","description":"Gets scoped context data for a masterSitecoreContextId  and sitecoreContextId within an organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetUserFilteredContext","name":"Retrieve scoped context data","isWebhook":false,"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{masterSitecoreContextId}~1filtered~1{sitecoreContextId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve scoped context data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets scoped context data for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"masterSitecoreContextId "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sitecoreContextId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within an organization."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"masterSitecoreContextId","in":"path","schemaId":"schema_1305","description":"Sitecore Context ID of the master context","required":true},{"name":"sitecoreContextId","in":"path","schemaId":"schema_1309","required":true}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{masterSitecoreContextId}~1filtered~1{sitecoreContextId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered/{sitecoreContextId}","servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"parameters":{"path":[{"name":"masterSitecoreContextId","in":"path","required":true,"example":"f9c3b17d181640efbbf3ae670311452d","schemaId":"schema_1305"},{"name":"sitecoreContextId","in":"path","required":true,"example":"fcb58fa476ebcc9df896d8e8608a718b","schemaId":"schema_1309"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered/{sitecoreContextId}","href":"scoped-context/getuserfilteredcontext","openApiOperationId":"GetUserFilteredContext","summary":"Retrieve scoped context data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Data successfully retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1307"}},"schemaId":"schema_1307"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request does not contain required scopes (expected"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ep.usr.ctx:r"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"404","description":"Data not found with the organizationId, masterSitecoreContextId, or sitecoreContextId","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{masterSitecoreContextId}~1filtered~1{sitecoreContextId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1307","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1307"}}},{"code":"401","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"403","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"404","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"500","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/scoped-context/getuserfilteredcontext"}],"panels":[]}]},"httpPath":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered/{sitecoreContextId}"}],"content":{"contentType":"group","meta":{"name":"Scoped context"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Scoped context","showPageActions":true},{"nodeType":"markdoc","content":"The Scoped context API lets you create and manage the scoped context in your organization. Scoped contexts are tied to the specified parent."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered","summary":"Create a scoped context","prefix":{"name":"post","color":"post"},"badges":[],"link":"/scoped-context/createuserfilteredcontext","deprecated":false},{"title":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered","summary":"List scoped contexts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scoped-context/listuserfilteredcontext","deprecated":false},{"title":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered/{sitecoreContextId}","summary":"Update a scoped context","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/scoped-context/updateuserfilteredcontext","deprecated":false},{"title":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered/{sitecoreContextId}","summary":"Delete scoped context","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/scoped-context/deleteuserfilteredcontext","deprecated":false},{"title":"/api/context/user/v1/contexts/{masterSitecoreContextId}/filtered/{sitecoreContextId}","summary":"Retrieve scoped context data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/scoped-context/getuserfilteredcontext","deprecated":false}]}]}]}]}},{"type":"group","label":"Products","link":"/portal/edge-platform-custom-context-api/products","routeSlug":"/portal/edge-platform-custom-context-api/products","items":[{"label":"List available products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal/edge-platform-custom-context-api/products/listuseravailableproducts","routeSlug":"/portal/edge-platform-custom-context-api/products/listuseravailableproducts","metadata":{"seo":{"title":"List available products","description":"Lists products in your organization that can be added to a context."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListUserAvailableProducts","name":"List available products","isWebhook":false,"pointer":"/paths/~1api~1context~1user~1v1~1available-products/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List available products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists products in your organization that can be added to a context."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/context/user/v1/available-products","servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","500"],"pointer":"/api/context/user/v1/available-products","href":"products/listuseravailableproducts","openApiOperationId":"ListUserAvailableProducts","summary":"List available products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1312"}},"schemaId":"schema_1312"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"}],"pointer":"/paths/~1api~1context~1user~1v1~1available-products/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1312","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1312"}}},{"code":"401","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"403","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"500","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/listuseravailableproducts"}],"panels":[]}]},"httpPath":"/api/context/user/v1/available-products"},{"label":"Add product resources to a context","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal/edge-platform-custom-context-api/products/createuserproduct","routeSlug":"/portal/edge-platform-custom-context-api/products/createuserproduct","metadata":{"seo":{"title":"Add product resources to a context","description":"Adds product-based resources to a specific context."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateUserProduct","name":"Add product resources to a context","isWebhook":false,"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}~1products/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add product resources to a context","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds product-based resources to a specific context."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"sitecoreContextId","in":"path","schemaId":"schema_1292","description":"Sitecore Context Id","required":true}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}~1products/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1313"}},"schemaId":"schema_1313","pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}~1products/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/context/user/v1/contexts/{sitecoreContextId}/products","servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"parameters":{"path":[{"name":"sitecoreContextId","in":"path","required":true,"example":"f9c3b17d181640efbbf3ae670311452d","schemaId":"schema_1292"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1313"}},"responseCodes":["201","401","404","409","422","500"],"pointer":"/api/context/user/v1/contexts/{sitecoreContextId}/products","href":"products/createuserproduct","openApiOperationId":"CreateUserProduct","summary":"Add product resources to a context"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"schemaId":"schema_1313","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1313"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1314"}},"schemaId":"schema_1314"},{"code":"401","description":"Unauthorized request or invalid access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"422","description":"Unprocessable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"},{"code":"500","description":"Server-side exception during request execution","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}},"schemaId":"schema_1290"}],"pointer":"/paths/~1api~1context~1user~1v1~1contexts~1{sitecoreContextId}~1products/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_1314","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1314"}}},{"code":"401","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"404","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"409","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"422","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}},{"code":"500","schemaId":"schema_1290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/createuserproduct"}],"panels":[]}]},"httpPath":"/api/context/user/v1/contexts/{sitecoreContextId}/products"}],"content":{"contentType":"group","meta":{"name":"Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Products","showPageActions":true},{"nodeType":"markdoc","content":"Product endpoints let you work at the product/tenant level instead of manually adding individual resources. You can retrieve all available product instances and attach a context to a product."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/context/user/v1/available-products","summary":"List available products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/listuseravailableproducts","deprecated":false},{"title":"/api/context/user/v1/contexts/{sitecoreContextId}/products","summary":"Add product resources to a context","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products/createuserproduct","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"schema_1288":{"kind":"json-schema","data":{"type":"object","properties":{"allowTracing":{"type":"string","example":"false"},"products":{"type":"array","items":{"type":"object","properties":{"productCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available values: \"XMCloud\" | \"Personalize\" | \"CDP\" | \"contenthub\""},"children":[]}]}]}],"example":"XMCloud"},"tenantId":{"type":"string","example":"g6c3b17d-1816-40ef-bbf3-ae670311452c"},"environment":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only for XMCloud product. Available values: \"Live\" | \"Preview\""},"children":[]}]}]}],"example":"Live"}},"required":["productCode","tenantId"]},"description":"Cannot be present with resources"},"resources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"SitecorePesonalizeResource"},"name":{"type":"string","example":"My Sitecore personalize resource"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"personalize | edge | search | forms | files"},"children":[]}]}]}],"example":"personalize"},"tenantId":{"type":"string","example":"g6c3b17d-1816-40ef-bbf3-ae670311452c"},"properties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Property id","example":"POS"},"value":{"type":"string","description":"Property value","example":"playwebsite"}},"required":["id","value"]}}},"required":["type","tenantId"]},"description":"Cannot be present with products"},"name":{"type":"string","example":"My Context"},"description":{"type":"string","example":"This is my context"}}},"id":"schema_1288"},"schema_1289":{"kind":"json-schema","data":{"type":"object","properties":{"organizationId":{"type":"string","example":"org_123ABC"},"sitecoreContextId":{"type":"string","example":"f9c3b17d181640efbbf3ae670311452d"},"allowTracing":{"type":"string","example":"false"},"type":{"type":"string","example":"custom"},"accountId":{"type":"string","example":"account001"},"resources":{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"SitecoreSearchResource"},"name":{"type":"string","example":"My Sitecore search resource"},"type":{"type":"string","example":"search"},"tenantId":{"type":"string","example":"g6c3b17d-1816-40ef-bbf3-ae670311452c"},"properties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Property id","example":"POS"},"value":{"type":"string","description":"Property value","example":"playwebsite"}},"required":["id","value"]}},"tenantName":{"type":"string","example":"tenant name"},"tenantProductCode":{"type":"string","example":"Search"}},"required":["id","name","type","tenantId","properties","tenantName","tenantProductCode"]}}},"name":{"type":"string","example":"My Context"},"description":{"type":"string","example":"This is my context"},"createdAt":{"type":"string","example":"2025-09-22T01:00:00Z"},"updatedAt":{"type":"string","example":"2025-09-22T01:00:00Z"}},"required":["organizationId","sitecoreContextId","allowTracing","type","accountId"]},"id":"schema_1289"},"schema_1290":{"kind":"json-schema","data":{"type":"object","properties":{"title":{"type":"string","example":"Unauthorized"},"type":{"type":"string","example":"Unauthorized"},"instance":{"type":"string","example":"/v1/context"},"status":{"type":"integer","example":500}},"required":["title","type","instance","status"]},"id":"schema_1290"},"schema_1291":{"kind":"json-schema","data":{"type":"string","description":"Sitecore Context ID","example":"f9c3b17d181640efbbf3ae670311452d"},"id":"schema_1291"},"schema_1292":{"kind":"json-schema","data":{"type":"string","description":"Sitecore Context Id","example":"f9c3b17d181640efbbf3ae670311452d"},"id":"schema_1292"},"schema_1293":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","example":"My Context"},"description":{"type":"string","example":"This is my context"}}},"id":"schema_1293"},"schema_1294":{"kind":"json-schema","data":{"type":"string","description":"Returns IDs only","example":"false"},"id":"schema_1294"},"schema_1295":{"kind":"json-schema","data":{"type":"integer","example":10},"id":"schema_1295"},"schema_1296":{"kind":"json-schema","data":{"type":"integer","example":1},"id":"schema_1296"},"schema_1297":{"kind":"json-schema","data":{"type":"object","properties":{"oneOf":{"type":"array","items":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"organizationId":{"type":"string","example":"org_123ABC"},"sitecoreContextId":{"type":"string","example":"5tc3b17d-1816-40ef-bbf3-ae6703546552c"},"type":{"type":"string","example":"xmcloud"},"accountId":{"type":"string","example":"account001"},"name":{"type":"string","example":"My Context"},"description":{"type":"string","example":"This is my context"},"resources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"SitecoreSearchResource"},"name":{"type":"string","example":"My Sitecore search resource"},"type":{"type":"string","example":"search"},"tenantId":{"type":"string","example":"g6c3b17d-1816-40ef-bbf3-ae670311452c"},"properties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Property id","example":"POS"},"value":{"type":"string","description":"Property value","example":"playwebsite"}},"required":["id","value"]}},"tenantName":{"type":"string","example":"tenant name"},"tenantProductCode":{"type":"string","example":"Search"}},"required":["id","name","type","tenantId","properties","tenantName","tenantProductCode"]}}},"required":["organizationId","type","accountId","resources"]}},"pageNumber":{"type":"integer","example":1},"pageSize":{"type":"integer","example":10},"totalCount":{"type":"integer","example":100}},"required":["data","pageNumber","pageSize","totalCount"]}}},"required":["oneOf"]},"id":"schema_1297"},"schema_1298":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","example":"SitecorePesonalizeResource"},"name":{"type":"string","example":"My Sitecore personalize resource"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"personalize | edge | search | forms | files"},"children":[]}]}]}],"example":"personalize"},"tenantId":{"type":"string","example":"g6c3b17d-1816-40ef-bbf3-ae670311452c"},"properties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Property id","example":"POS"},"value":{"type":"string","description":"Property value","example":"playwebsite"}},"required":["id","value"]}}},"required":["type","tenantId"]},"id":"schema_1298"},"schema_1299":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","example":"SitecoreSearchResource"},"name":{"type":"string","example":"My Sitecore search resource"},"type":{"type":"string","example":"search"},"tenantId":{"type":"string","example":"g6c3b17d-1816-40ef-bbf3-ae670311452c"},"properties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Property id","example":"POS"},"value":{"type":"string","description":"Property value","example":"playwebsite"}},"required":["id","value"]}}},"required":["id","name","type","tenantId","properties"]},"id":"schema_1299"},"schema_1300":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"SitecoreSearchResource"},"name":{"type":"string","example":"My Sitecore search resource"},"type":{"type":"string","example":"search"},"tenantId":{"type":"string","example":"g6c3b17d-1816-40ef-bbf3-ae670311452c"},"properties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Property id","example":"POS"},"value":{"type":"string","description":"Property value","example":"playwebsite"}},"required":["id","value"]}},"tenantName":{"type":"string","example":"tenant name"},"tenantProductCode":{"type":"string","example":"Search"}},"required":["id","name","type","tenantId","properties","tenantName","tenantProductCode"]}},"id":"schema_1300"},"schema_1301":{"kind":"json-schema","data":{"type":"string","description":"Resource Id","example":"SitecorePesonalizeResource"},"id":"schema_1301"},"schema_1302":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","example":"SitecoreSearchResource"},"name":{"type":"string","example":"My Sitecore search resource"},"type":{"type":"string","example":"search"},"tenantId":{"type":"string","example":"g6c3b17d-1816-40ef-bbf3-ae670311452c"},"tenantName":{"type":"string","example":"tenant name"},"tenantProductCode":{"type":"string","example":"Search"},"properties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Property id","example":"POS"},"value":{"type":"string","description":"Property value","example":"playwebsite"}},"required":["id","value"]}}},"required":["id","name","type","tenantId","tenantName","tenantProductCode","properties"]},"id":"schema_1302"},"schema_1303":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"personalize | edge | search | forms | files"},"children":[]}]}]}],"example":"personalize"},"id":"schema_1303"},"schema_1304":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"tenantId":{"type":"string","example":"SitecoreSearchResource"},"tenantName":{"type":"string","example":"My Sitecore search resource"},"type":{"type":"string","example":"search"}},"required":["tenantId","tenantName","type"]}},"id":"schema_1304"},"schema_1305":{"kind":"json-schema","data":{"type":"string","description":"Sitecore Context ID of the master context","example":"f9c3b17d181640efbbf3ae670311452d"},"id":"schema_1305"},"schema_1306":{"kind":"json-schema","data":{"type":"object","properties":{"sitecoreContextId":{"type":"string","example":"f9c3b17d181640efbbf3ae670311452d"},"name":{"type":"string","example":"Scoped context name"},"allowedResourceIds":{"type":"array","items":{"type":"string","description":"Allowed resource IDs","example":"sitecoreFormsResource"}}}},"id":"schema_1306"},"schema_1307":{"kind":"json-schema","data":{"type":"object","properties":{"sitecoreContextId":{"type":"string","example":"fcb58fa476ebcc9df896d8e8608a718b"},"name":{"type":"string","example":"Scoped context name"},"masterSitecoreContextId":{"type":"string","example":"5f81f0627a2e9233d71e8e84f2c0b8e2"},"allowedResourceIds":{"type":"array","items":{"type":"string","description":"Allowed resource IDs","example":"sitecoreFormsResource"}},"createdAt":{"type":"string","example":"2025-09-22T01:00:00Z"},"updatedAt":{"type":"string","example":"2025-09-22T01:00:00Z"}},"required":["sitecoreContextId","masterSitecoreContextId"]},"id":"schema_1307"},"schema_1308":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"sitecoreContextId":{"type":"string","example":"fcb58fa476ebcc9df896d8e8608a718b"},"name":{"type":"string","example":"Scoped context name"},"masterSitecoreContextId":{"type":"string","example":"5f81f0627a2e9233d71e8e84f2c0b8e2"},"allowedResourceIds":{"type":"array","items":{"type":"string","description":"Allowed resource Ids","example":"sitecoreFormsResource"}},"createdAt":{"type":"string","example":"2025-09-22T01:00:00Z"},"updatedAt":{"type":"string","example":"2025-09-22T01:00:00Z"}},"required":["sitecoreContextId","masterSitecoreContextId"]}},"id":"schema_1308"},"schema_1309":{"kind":"json-schema","data":{"type":"string","example":"fcb58fa476ebcc9df896d8e8608a718b"},"id":"schema_1309"},"schema_1310":{"kind":"json-schema","data":{"type":"object","properties":{"allowedResourceIds":{"type":"array","items":{"type":"string","description":"Allowed resource IDs","example":"sitecoreFormsResource"}},"name":{"type":"string","example":"Scoped context name"}}},"id":"schema_1310"},"schema_1311":{"kind":"json-schema","data":{"type":"object","properties":{"sitecoreContextId":{"type":"string","example":"fcb58fa476ebcc9df896d8e8608a718b"},"name":{"type":"string","example":"Scoped context name"},"masterSitecoreContextId":{"type":"string","example":"5f81f0627a2e9233d71e8e84f2c0b8e2"},"allowedResourceIds":{"type":"array","items":{"type":"string","description":"Allowed resource Ids","example":"sitecoreFormsResource"}},"createdAt":{"type":"string","example":"2025-09-22T01:00:00Z"},"updatedAt":{"type":"string","example":"2025-09-22T01:00:00Z"}},"required":["sitecoreContextId","masterSitecoreContextId"]},"id":"schema_1311"},"schema_1312":{"kind":"json-schema","data":{"type":"object","properties":{"productCode":{"type":"string","example":"XMCloud"},"tenantId":{"type":"string","example":"f9c3b17d181640efbbf3ae670311452d"},"tenantName":{"type":"string","example":"My XMC project | Production"},"environment":{"type":"string","description":"Only for XM CLoud product. values will be \"Live\" or \"Preview\"","example":"Live"}},"required":["productCode","tenantId","tenantName","environment"]},"id":"schema_1312"},"schema_1313":{"kind":"json-schema","data":{"type":"object","properties":{"productCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available values: \"XMCloud\" | \"Personalize\" | \"CDP\" | \"contenthub\""},"children":[]}]}]}],"example":"XMCloud"},"tenantId":{"type":"string","example":"g6c3b17d-1816-40ef-bbf3-ae670311452c"},"environment":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only for XMCloud product. Available values: \"Live\" | \"Preview\""},"children":[]}]}]}],"example":"Live"}},"required":["productCode","tenantId"]},"id":"schema_1313"},"schema_1314":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"SitecoreSearchResource"},"name":{"type":"string","example":"My Sitecore search resource"},"type":{"type":"string","example":"search"},"tenantId":{"type":"string","example":"g6c3b17d-1816-40ef-bbf3-ae670311452c"},"properties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Property id","example":"POS"},"value":{"type":"string","description":"Property value","example":"playwebsite"}},"required":["id","value"]}}},"required":["id","name","type","tenantId","properties"]}},"id":"schema_1314"}},"exampleStore":{},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"https://edge-platform-context-api.sitecorecloud.io"}],"specType":"openapi"},"options":{"hideInfoMetadata":true,"sanitize":true,"sortRequiredPropsFirst":true,"corsProxyUrl":"https://cors.redoc.ly","mockServer":{"off":true,"position":"off"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/portal/edge-platform-custom-context-api/index.json?download"},{"url":"/_bundle/portal/edge-platform-custom-context-api/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Edge Platform Custom Context API","description":"Use the Custom Context API to create, retrieve, update, and delete the [context](https://doc.sitecore.com/portal/en/developers/sitecore-cloud-portal/context-ids.html). A context ID is a unified identifier that grants access to specific resources in a Sitecore Cloud Portal organization and is helps determine the context for an organization. \n\n To use this REST API, you must authenticate your API requests. Keep in mind: \n\n - All API requests are made in your production environment.\n\n - The base URL is `https://edge-platform-context-api.sitecorecloud.io`.\n\n<b>NOTE</b>: You must have an [*Organization Admin* or *Organization Owner* role](https://doc.sitecore.com/portal/en/developers/sitecore-cloud-portal/roles.html#organization-roles) in Sitecore Cloud Portal. \n\n## Authentication\n\nThe Edge Platform Context API uses [bearer](https://doc.sitecore.com/portal/en/developers/sitecore-cloud-portal/manage-api-tokens.html) authentication. Bearer tokens are generated in response to a login request.\n\nTo get a bearer token:\n\n 1. Log in to the [Sitecore Cloud Portal](https://portal.sitecorecloud.io/).\n\n 2. In the top-right corner of the menu bar, click your profile icon > **API tokens**.\n\n 3. Click **Copy to clipboard**.\n\nYou can now start making REST API requests. You must include this token in the authorization header of every request you make.","product":"Cloud Portal"}},"baseSlug":"/portal/edge-platform-custom-context-api","routesMapping":{}}