The API commands should never be used by a public application. Your Sitecore CDP/Personalize API Username and Password should never be send to anyone you don't trust. It's recommended that you create a Service API account in your Sitecore CDP/Personalize tenant so you can have more control over revoking access in the future.
All authentication commands start with auth.
| Subcommand | Description | Parameters |
|---|---|---|
| login | Required command to create access token for future CLI commands | -id, --clientId -s, --clientSecret -c, --cloudPortal optional (to use the Cloud Portal authentication, pass parameter, otherwise its false) -l, --location optional (defaults to EU) |
| status | View Authentication/Service Url information | <none> |
| logout | Logout of the API | <none> |
npx sitecore-cdp-serializer auth login -id {Client Key} -s {API Token} -c {True|False} -l {EU|US|APJ}All template commands start with templates.
| Subcommand | Description | Parameters |
|---|---|---|
| get | Gets a list of Templates from the CDP/Personalize tenant | --friendlyId optional --templateRef optional |
| create | Creates a New Template based on a JSON object | -t, --template |
| update | Updates an Existing Template based on a JSON object | -t, --template |
npx sitecore-cdp-serializer templates get --friendlyId 'sitecore_test_template_1'In order to run a templates command, you must have already run an auth login command to authenticate to the tenant you wish to access templates from.
⚠️ Currently JS Modules support only allows for a single push and once published they cannot be modified even by the API. This means that if you have already published a JS Module, you will need to delete it from the tenant before you can run a deploy command again. This is a limitation of the API and not the CLI.