Credentials
Store SFCC accounts, access keys, and API clients before creating connections
Credentials are the first setup step. A credential record is reusable: one account or API client can be referenced by several sandbox connections without retyping the same secret in every connection form.
What To Add
| Credential | Used for | Notes |
|---|---|---|
| Business Manager account | WebDAV, Business Manager, debugger, and general sandbox access. | Add the username and password once, then reuse it in connections. |
| Host access keys | WebDAV, OCAPI, or Storefront access for a specific hostname. | Use these when the sandbox expects access-key authentication instead of only a password. |
| OCAPI or SCAPI client | Code version, sandbox metadata, API exploration, and other API-backed actions. | Store the client ID and secret in the credentials page, then select it from a connection. |
VS Code Storage Model
The VS Code extension stores credential data in a linked .creds file. When you create a new credentials file, the extension creates a 24-character secret key, links the file path in the intellij-sfcc.credentialsFilePath setting, and stores the secret key in VS Code SecretStorage under the extension secret key slot.
The .creds file contains the encrypted accounts and API clients. The extension keeps a local in-memory view and a workspace/global-state cache so tree views, webviews, connection pickers, and downstream managers can refresh quickly. The Credentials webview shows masked values by default and reveals secrets only when you explicitly request them.
Open Credentials
Open the Intellij SFCC activity-bar container and choose Credentials.
Create or link the file
Use Create credentials file for a new intellij-sfcc-credentials.creds style file, or link an existing .creds file and provide its 24-character secret key.
Add accounts and API clients
Add the Business Manager account, hostname access keys, and OCAPI or SCAPI clients you need.
Sync when needed
Use sync when the file changes outside the IDE or after importing credentials from another setup.
JetBrains Storage Model
The JetBrains plugin uses CredentialsIOManager for credentials-file import/export and synchronization. It stores the linked file path, secret key, first-import flag, and file hash in the IDE persistent state named IntellijSFCC-CredentialsIOManager.
Individual IDE passwords are stored through JetBrains PasswordSafe, which delegates to the operating-system credential store or the IDE password database depending on the user's IDE settings. The plugin watches the linked credentials file, reimports it when the encrypted file changes, and refreshes opened projects after successful sync.
Open B2C Credentials
Open B2C Credentials from the right tool-window stripe.
Create or import credentials
Create a new credentials file or import an existing encrypted .creds file with its secret key.
Add account data
Add Business Manager accounts, per-host access keys, and OCAPI or SCAPI credentials.
Sync the file
Use sync-to-file after local edits and sync-from-file after the file was changed externally.
Sharing Rules
- Share the
.credsfile only with people who should have access to the contained accounts and API clients. - Share the secret key through a separate secure channel.
- Do not commit the credentials file or secret key to a project repository.
- Connection exports are safe only as connection metadata; they still need the matching credentials to be useful.
- Remove stale accounts and API clients before sharing a credentials file with a new team member.
Troubleshooting
| Symptom | Check |
|---|---|
| Credentials file cannot be read | Confirm the file path exists and the secret key matches the encrypted file. |
| Connection has no account | Add the account in Credentials first, then reselect it in the connection editor. |
| API actions fail | Confirm the connection references the intended OCAPI or SCAPI client and that the client secret is present. |
| Password changed in Business Manager | Update the account in Credentials, then sync and retry the connection. |