Authenticator
The Authenticator API provides endpoints for managing storefront user registration and B2B password migration configuration.
This feature is only available for stores using B2B Buyer Portal, which is currently available to selected accounts. For general store user authentication, see the VTEX ID API.
For more information on provisioning B2B users, see the B2B user provisioning guide.
Common parameters
| Parameter name | Description | Type |
|---|---|---|
accountName |
Name of the VTEX account. Used as part of the URL. | Server variable. |
environment |
Environment to use. Used as part of the URL. | Server variable. |
Endpoints
Storefront users
| Summary | Method | Path |
|---|---|---|
| Create storefront user | POST | /api/authenticator/v1/storefront/users |
Password migration
| Summary | Method | Path |
|---|---|---|
| Upsert password migration configuration | PUT | /api/authenticator/v1/tenants/features/{name} |
| Enable or disable password migration | PATCH | /api/authenticator/v1/tenants/features/{name} |
| Delete password migration configuration | DELETE | /api/authenticator/v1/tenants/features/{name} |