@salesforce/b2c-tooling-sdk / operations/users
operations/users ​
Account Manager user management operations.
This module provides high-level functions for managing users in Account Manager, including CRUD operations, role management, and user lifecycle operations.
Core User Functions ​
- getUser - Get user details by ID
- getUserByLogin - Get user details by login (email)
- listUsers - List users with pagination
- createUser - Create a new user
- updateUser - Update an existing user
- deleteUser - Disable a user (soft delete)
- purgeUser - Purge a disabled user (hard delete)
- resetUser - Reset a user to INITIAL state
Usage ​
typescript
import {
getUserByLogin,
listUsers,
createUser,
grantRole,
} from '@salesforce/b2c-tooling-sdk/operations/users';
import { createAccountManagerUsersClient } from '@salesforce/b2c-tooling-sdk/clients';
import { OAuthStrategy } from '@salesforce/b2c-tooling-sdk/auth';
const auth = new OAuthStrategy({
clientId: 'your-client-id',
clientSecret: 'your-client-secret',
});
const client = createAccountManagerUsersClient({}, auth);
// Get a user by login
const user = await getUserByLogin(client, 'user@example.com');
// List users
const users = await listUsers(client, { size: 25, page: 0 });
// Create a new user
const newUser = await createUser(client, {
mail: 'newuser@example.com',
firstName: 'John',
lastName: 'Doe',
organizations: ['org-id'],
primaryOrganization: 'org-id',
});Authentication ​
User operations require OAuth authentication with appropriate Account Manager permissions.
Interfaces ​
Functions ​
References ​
AccountManagerUser ​
Re-exports AccountManagerUser
deleteUser ​
Re-exports deleteUser
getUser ​
Re-exports getUser
listUsers ​
Re-exports listUsers
purgeUser ​
Re-exports purgeUser
resetUser ​
Re-exports resetUser
UserCollection ​
Re-exports UserCollection
UserCreate ​
Re-exports UserCreate
UserUpdate ​
Re-exports UserUpdate