---
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:1297](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1297)

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:1342](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1342)

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:1336](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1336)

Create a new API client

#### Parameters

##### body

#### Returns

`Promise`\<\{ \}\>

***

### createUser()

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

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1304](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1304)

Create a new user

#### Parameters

##### user

#### Returns

`Promise`\<\{ \}\>

***

### deleteApiClient()

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

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:1340](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1340)

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:1308](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1308)

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:1314](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1314)

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:1334](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1334)

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:1346](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1346)

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:1348](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1348)

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:1328](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1328)

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:1322](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1322)

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:1326](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1326)

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:1300](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1300)

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:1316](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1316)

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:1332](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1332)

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:1350](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1350)

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:1324](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1324)

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:1302](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1302)

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:1310](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1310)

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:1312](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1312)

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:1318](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1318)

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:1338](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1338)

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:1306](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/67fb8580ac3c5b372617ee3ec3fc8f2bc9f16174/packages/b2c-tooling-sdk/src/clients/am-api.ts#L1306)

Update an existing user

#### Parameters

##### userId

`string`

##### changes

#### Returns

`Promise`\<\{ \}\>