j
Users
1.0.0
API Overview
The Users API provides endpoints for managing Business Manager users and their access keys within Salesforce Commerce Cloud.
Overview
This API allows administrators to create, retrieve, update, and delete users. It also supports managing access keys for users, retrieving password expiration information, and changing user passwords.
Key Features
- User Management: Create, retrieve, update, and delete Business Manager users
- Access Key Management: Create, retrieve, enable/disable, and delete access keys for users
- Password Management: Retrieve password expiration information and change passwords
- User Listing: Retrieve all users with no filtering
Access Key Scopes
Access keys can be created for the following scopes:
WEBDAV_AND_STUDIO: Access for WebDAV and Studio operationsAGENT_USER_AND_OCAPI: Access for Agent User and OCAPI operationsSTOREFRONT: Access for storefront operations
Use Cases
- Provisioning: Create and configure Business Manager users programmatically
- Key Rotation: Manage access keys for automated integrations
- Security Auditing: Review user accounts and their access configurations
- Password Policies: Monitor password expiration and enforce password changes
Authentication
This API requires OAuth 2.0 authentication with the appropriate scopes:
sfcc.users- Read access to user resourcessfcc.users.rw- Read and write access to user resources
Best Practices
- Use access keys instead of passwords for automated integrations
- Regularly rotate access keys for security
- Monitor password expiration dates and enforce timely password changes
- Use the PATCH endpoint for partial updates instead of PUT for full overwrites
- Only externally managed users can have access keys
https://{shortCode}.api.commercecloud.salesforce.com/merchant/users/v1
DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!
Let us know so we can improve!