Salesforce Commerce Cloud
Integrate OwnID into Salesforce Commerce Cloud using a cartridge.
By integrating Salesforce Commerce Cloud (SFCC) with OwnID, you can implement the full set of OwnID features to simplify and streamline your user login experience.
How it Works
OwnID integrates with the SFCC built-in API client, using our native SFCC Connector and an SFCC cartridge.
Integrate OwnID with SFCC by completing these three basic steps:
Step 1 - Get SFCC Credentials.
Step 2 - Create an OwnID application in the OwnID Console.
Step 3 - Install the SFCC Cartridge.
Prerequisites
Download the Salesforce Commerce Cloud cartridge here.
Step 1 - Add SFCC Client
Integration requires you to create a new API Client in your SFCC instance.
Create Credentials
See: Add an API Client in B2C Commerce
- Log into the SFCC Account Manager.
- Select API Client from the left side menu.
- Click Add API Client.
- Enter “OwnID Integration” in Display Name.
- Enter a password.
- Assign your organization.
- Assign the following roles:
Sandbox API User
Salesforce Commerce Cloud
- In the Token Endpoint Auth Method, select
private_key_jwt
. - Click Save Changes.
![SFCC Account Manager API client setting screen](https://mintlify.s3-us-west-1.amazonaws.com/ownid/images/oi_sf_client.png)
Salesforce displays your Client Id
and Secret
. Save these values for later use.
Assign Permissions
-
Go to Administration > Site Development > Open Commerce API Settings.
-
Add the following JSON object to the shop tab:
{
"_v": "23.1",
"clients": [
{
"allowed_origins": [
],
"client_id": "Client ID",
"resources": [
{
"resource_id": "/customers/auth/trustedsystem",
"methods": [
"post"
],
"read_attributes": "(**)",
"write_attributes": "(**)"
},
{
"resource_id": "/sessions",
"methods": [
"post"
],
"read_attributes": "(**)",
"write_attributes": "(**)"
}
]
}
]
}
-
Change
client_id
value in the shop JSON to match theClient Id
created in the previous step. -
If the OCAPI configuration is already in place, simply include the following resource into the resources section.
{
"resource_id": "/customers/auth/trustedsystem",
"methods": [
"post"
],
"read_attributes": "(**)",
"write_attributes": "(**)"
},
{
"resource_id": "/sessions",
"methods": [
"post"
],
"read_attributes": "(**)",
"write_attributes": "(**)"
}
![SFCC Account Manager data tab configuration with JSON sample](https://mintlify.s3-us-west-1.amazonaws.com/ownid/images/oi_sf_tab.png)
- Add the following JSON object to the data tab:
{
"_v": "23.1",
"clients": [
{
"allowed_origins": [
],
"client_id": "Your Client ID",
"resources": [
{
"resource_id": "/customer_lists/*/customers/*",
"methods": ["get", "patch"],
"read_attributes": "(**)",
"write_attributes": "(**)"
},
{
"resource_id":"/customer_lists/*/customer_search",
"methods": ["post"],
"read_attributes": "(**)",
"write_attributes": "(**)"
},
{
"resource_id":"/ocapi_configs/*",
"methods": ["get"],
"read_attributes": "(**)",
"write_attributes": "(**)"
}
]
}
]
}
![SFCC Account Manager](https://mintlify.s3-us-west-1.amazonaws.com/ownid/images/SFCC-data-json.jpeg)
- Modify the
client_id
value in the JSON object to match the Client Id created in the previous step.
Securing User’s Personal Data
OwnID does not store or process any user data. Users’ public keys and device information are stored on your platform.
Private keys are kept exclusively on the user’s device and are never transmitted elsewhere.
Step 2 - Create OwnID Application
An OwnID App is what connects the existing identity provider used by your website with the OwnID widget you insert on the front end.
![OwnID Widget](https://mintlify.s3-us-west-1.amazonaws.com/ownid/images/oi-widg-s.png)
Each of your OwnID Apps acts as the central point of configuration for each of your integrations. These no-code Apps are created, hosted, and maintained entirely within the OwnID Console environment.
When you create an App, it’s assigned a unique appId
automatically. Use that appId
in OwnID SDK interaction from your website’s front end.
To Create an OwnID App
-
Login to the OwnID Console (or create your account).
-
Click +Create Application from the Apps screen.
-
Enter a name for your application in the App name field.
-
From the Choose your integration panel, select the tile.
-
Click Next.
-
Enter the URL to your application instance and click Continue.
-
Click Explore my App on the “Congratulations” popup.
-
From the OwnID Settings panel, copy the App ID and the Shared Secret for use in configuration on the side.
- Open the Salesforce integration page in the OwnID Console.
- Enter the Instance Hostname - e.g: xyzb-001.dx.commercecloud.salesforce.com (only the domain, without protocol).
- Enter a Site ID - e.g: RefArch (case sensitive).
- Enter the API Client ID (generated in the previous step).
- Enter the API Client Secret (generated in the previous step).
- Enter the SFCC Username (get it from the Account Manager).
- Enter the SFCC Password.
- Click Save Changes.
![Salesforce Commerce integration page in the OwnID Console](https://mintlify.s3-us-west-1.amazonaws.com/ownid/images/SFCC-ownid-console.jpeg)
Copy the appId
so you can use it in the next step.
Step 3 - Install the SFCC Cartridge
- Upload and add the cartridge to the target site.
- Navigate to Merchant Tools > Site Preferences > Custom Preferences > OwnID and set the following preferences:
- Set
EnableOwnId
totrue
to display the OwnID widget. Env
Select the OwnID production environment.- Enter the
AppId
previously copied from the OwnID Console.
![OwnID cartridge configuration page in SFCC](https://mintlify.s3-us-west-1.amazonaws.com/ownid/images/SFCC-cartridge.jpeg)
Next Steps
Ready to deploy?
YES!
Take me to the Deployment Checklist
Was this page helpful?