---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../modules.md) / 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](../../clients/functions/getUser.md) - Get user details by ID
- [getUserByLogin](functions/getUserByLogin.md) - Get user details by login (email)
- [listUsers](../../clients/functions/listUsers.md) - List users with pagination
- [createUser](functions/createUser.md) - Create a new user
- [updateUser](functions/updateUser.md) - Update an existing user
- [deleteUser](../../clients/functions/deleteUser.md) - Disable a user (soft delete)
- [purgeUser](../../clients/functions/purgeUser.md) - Purge a disabled user (hard delete)
- [resetUser](../../clients/functions/resetUser.md) - 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

- [CreateUserOptions](interfaces/CreateUserOptions.md)
- [GrantRoleOptions](interfaces/GrantRoleOptions.md)
- [RevokeRoleOptions](interfaces/RevokeRoleOptions.md)
- [UpdateUserOptions](interfaces/UpdateUserOptions.md)

## Functions

- [createUser](functions/createUser.md)
- [getUserByLogin](functions/getUserByLogin.md)
- [grantRole](functions/grantRole.md)
- [revokeRole](functions/revokeRole.md)
- [updateUser](functions/updateUser.md)

## References

### AccountManagerUser

Re-exports [AccountManagerUser](../../clients/type-aliases/AccountManagerUser.md)

***

### deleteUser

Re-exports [deleteUser](../../clients/functions/deleteUser.md)

***

### getUser

Re-exports [getUser](../../clients/functions/getUser.md)

***

### listUsers

Re-exports [listUsers](../../clients/functions/listUsers.md)

***

### purgeUser

Re-exports [purgeUser](../../clients/functions/purgeUser.md)

***

### resetUser

Re-exports [resetUser](../../clients/functions/resetUser.md)

***

### UserCollection

Re-exports [UserCollection](../../clients/type-aliases/UserCollection.md)

***

### UserCreate

Re-exports [UserCreate](../../clients/type-aliases/UserCreate.md)

***

### UserUpdate

Re-exports [UserUpdate](../../clients/type-aliases/UserUpdate.md)
