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

[@salesforce/b2c-tooling-sdk](../../modules.md) / [clients](../index.md) / AccountManagerClient

# Interface: AccountManagerClient

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1272](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1272)

Unified Account Manager API client that combines users, roles, and organizations.

This client provides direct access to all Account Manager API methods through
a single interface, while internally using separate typed clients for type safety.

## Methods

### changeApiClientPassword()

> **changeApiClientPassword**(`apiClientId`, `oldPassword`, `newPassword`): `Promise`\<`void`\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1317](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1317)

Change an API client password

#### Parameters

##### apiClientId

`string`

##### oldPassword

`string`

##### newPassword

`string`

#### Returns

`Promise`\<`void`\>

***

### createApiClient()

> **createApiClient**(`body`): `Promise`\<\{ \}\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1311](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1311)

Create a new API client

#### Parameters

##### body

#### Returns

`Promise`\<\{ \}\>

***

### createUser()

> **createUser**(`user`): `Promise`\<\{ \}\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1279](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1279)

Create a new user

#### Parameters

##### user

#### Returns

`Promise`\<\{ \}\>

***

### deleteApiClient()

> **deleteApiClient**(`apiClientId`): `Promise`\<`void`\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1315](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1315)

Delete an API client (must be disabled 7+ days)

#### Parameters

##### apiClientId

`string`

#### Returns

`Promise`\<`void`\>

***

### deleteUser()

> **deleteUser**(`userId`): `Promise`\<`void`\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1283](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1283)

Disable a user (soft delete)

#### Parameters

##### userId

`string`

#### Returns

`Promise`\<`void`\>

***

### findUserByLogin()

> **findUserByLogin**(`login`, `expand?`): `Promise`\<\{ \} \| `undefined`\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1289](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1289)

Find a user by login (email)

#### Parameters

##### login

`string`

##### expand?

(`"roles"` \| `"organizations"`)[]

#### Returns

`Promise`\<\{ \} \| `undefined`\>

***

### getApiClient()

> **getApiClient**(`apiClientId`, `expand?`): `Promise`\<\{ \}\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1309](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1309)

Get API client by ID

#### Parameters

##### apiClientId

`string`

##### expand?

(`"roles"` \| `"organizations"`)[]

#### Returns

`Promise`\<\{ \}\>

***

### getOrg()

> **getOrg**(`orgId`): `Promise`\<[`AccountManagerOrganization`](AccountManagerOrganization.md)\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1321](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1321)

Get organization by ID

#### Parameters

##### orgId

`string`

#### Returns

`Promise`\<[`AccountManagerOrganization`](AccountManagerOrganization.md)\>

***

### getOrgByName()

> **getOrgByName**(`name`): `Promise`\<[`AccountManagerOrganization`](AccountManagerOrganization.md)\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1323](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1323)

Get organization by name

#### Parameters

##### name

`string`

#### Returns

`Promise`\<[`AccountManagerOrganization`](AccountManagerOrganization.md)\>

***

### getOrgMapping()

> **getOrgMapping**(): `Promise`\<[`OrgMapping`](OrgMapping.md)\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1303](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1303)

Get the org mapping (id → name), lazily cached

#### Returns

`Promise`\<[`OrgMapping`](OrgMapping.md)\>

***

### getRole()

> **getRole**(`roleId`): `Promise`\<\{ \}\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1297](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1297)

Get role by ID

#### Parameters

##### roleId

`string`

#### Returns

`Promise`\<\{ \}\>

***

### getRoleMapping()

> **getRoleMapping**(): `Promise`\<[`RoleMapping`](RoleMapping.md)\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1301](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1301)

Get the role mapping (id ↔ roleEnumName), lazily cached

#### Returns

`Promise`\<[`RoleMapping`](RoleMapping.md)\>

***

### getUser()

> **getUser**(`userId`, `expand?`): `Promise`\<\{ \}\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1275](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1275)

Get user by ID

#### Parameters

##### userId

`string`

##### expand?

(`"roles"` \| `"organizations"`)[]

#### Returns

`Promise`\<\{ \}\>

***

### grantRole()

> **grantRole**(`userId`, `role`, `scope?`): `Promise`\<\{ \}\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1291](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1291)

Grant a role to a user, optionally with scope

#### Parameters

##### userId

`string`

##### role

`string`

##### scope?

`string`

#### Returns

`Promise`\<\{ \}\>

***

### listApiClients()

> **listApiClients**(`options?`): `Promise`\<\{ \}\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1307](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1307)

List API clients with pagination

#### Parameters

##### options?

[`ListApiClientsOptions`](ListApiClientsOptions.md)

#### Returns

`Promise`\<\{ \}\>

***

### listOrgs()

> **listOrgs**(`options?`): `Promise`\<[`OrganizationCollection`](OrganizationCollection.md)\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1325](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1325)

List organizations with pagination

#### Parameters

##### options?

[`ListOrgsOptions`](ListOrgsOptions.md)

#### Returns

`Promise`\<[`OrganizationCollection`](OrganizationCollection.md)\>

***

### listRoles()

> **listRoles**(`options?`): `Promise`\<\{ \}\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1299](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1299)

List roles with pagination

#### Parameters

##### options?

[`ListRolesOptions`](ListRolesOptions.md)

#### Returns

`Promise`\<\{ \}\>

***

### listUsers()

> **listUsers**(`options?`): `Promise`\<\{ \}\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1277](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1277)

List users with pagination

#### Parameters

##### options?

[`ListUsersOptions`](ListUsersOptions.md)

#### Returns

`Promise`\<\{ \}\>

***

### purgeUser()

> **purgeUser**(`userId`): `Promise`\<`void`\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1285](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1285)

Purge a user (hard delete)

#### Parameters

##### userId

`string`

#### Returns

`Promise`\<`void`\>

***

### resetUser()

> **resetUser**(`userId`): `Promise`\<`void`\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1287](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1287)

Reset a user to INITIAL state

#### Parameters

##### userId

`string`

#### Returns

`Promise`\<`void`\>

***

### revokeRole()

> **revokeRole**(`userId`, `role`, `scope?`): `Promise`\<\{ \}\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1293](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1293)

Revoke a role from a user, optionally removing specific scope

#### Parameters

##### userId

`string`

##### role

`string`

##### scope?

`string`

#### Returns

`Promise`\<\{ \}\>

***

### updateApiClient()

> **updateApiClient**(`apiClientId`, `body`): `Promise`\<\{ \}\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1313](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1313)

Update an existing API client

#### Parameters

##### apiClientId

`string`

##### body

#### Returns

`Promise`\<\{ \}\>

***

### updateUser()

> **updateUser**(`userId`, `changes`): `Promise`\<\{ \}\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1281](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1281)

Update an existing user

#### Parameters

##### userId

`string`

##### changes

#### Returns

`Promise`\<\{ \}\>