Skip to content

Commit b6d2879

Browse files
committed
docs(auth): clarify WebDAV Basic Auth is for user access, OAuth for API clients
1 parent f3d2d9e commit b6d2879

2 files changed

Lines changed: 15 additions & 7 deletions

File tree

.changeset/webdav-auth-language.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@salesforce/b2c-dx-docs': patch
3+
---
4+
5+
Clarify WebDAV authentication guidance: Basic Auth is for interactive user-based access while OAuth is for API clients and CI/CD, rather than labeling Basic Auth as generally "recommended".

docs/guide/authentication.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -506,11 +506,14 @@ b2c scapi schemas list
506506

507507
## WebDAV Access
508508

509-
WebDAV is required for file upload operations (`code deploy`, `code watch`, `webdav` commands).
509+
WebDAV is required for file upload operations (`code deploy`, `code watch`, `webdav` commands). There are two ways to authenticate, depending on who (or what) is connecting:
510510

511-
### Option A: Basic Authentication (Recommended)
511+
- **Basic Authentication** — for individual developers using their own Business Manager account during interactive, local development.
512+
- **OAuth** — for API clients and automation (CI/CD pipelines, scripts) where no human is logging in.
512513

513-
Use your Business Manager username and a WebDAV access key. These credentials provide better performance for file operations.
514+
### Option A: Basic Authentication (user access)
515+
516+
Use your Business Manager username and a WebDAV access key. This is the simplest option for interactive, user-based access during local development.
514517

515518
1. In Business Manager, go to **Administration** > **Organization** > **Users**
516519
2. Select your user
@@ -523,9 +526,9 @@ export SFCC_USERNAME=your-bm-username
523526
export SFCC_PASSWORD=your-webdav-access-key
524527
```
525528

526-
### Option B: OAuth-based WebDAV
529+
### Option B: OAuth-based WebDAV (API client access)
527530

528-
If you prefer to use OAuth credentials for WebDAV (instead of basic auth), you must configure WebDAV Client Permissions:
531+
For API clients and automation (CI/CD), use OAuth credentials instead of a user's basic auth. This requires configuring WebDAV Client Permissions for the API client:
529532

530533
1. Log in to Business Manager
531534
2. Navigate to **Administration** > **Organization** > **WebDAV Client Permissions**
@@ -604,8 +607,8 @@ Add the JSON configuration shown in [OCAPI Configuration](#ocapi-configuration)
604607

605608
Either:
606609

607-
- Use your BM username + WebDAV access key (recommended), or
608-
- Configure WebDAV Client Permissions for OAuth
610+
- Use your BM username + WebDAV access key (for user-based, interactive development), or
611+
- Configure WebDAV Client Permissions for OAuth (for API clients and CI/CD)
609612

610613
### 4. Set Environment Variables
611614

0 commit comments

Comments
 (0)