Skip to content

@salesforce/b2c-tooling-sdk / clients / AccountManagerOrgsClient

Interface: AccountManagerOrgsClient ​

Defined in: packages/b2c-tooling-sdk/src/clients/am-api.ts:951

Account Manager Organizations API client.

Methods ​

getOrg() ​

getOrg(orgId): Promise<AccountManagerOrganization>

Defined in: packages/b2c-tooling-sdk/src/clients/am-api.ts:955

Get organization by ID.

Parameters ​

orgId ​

string

Returns ​

Promise<AccountManagerOrganization>


getOrgByName() ​

getOrgByName(name): Promise<AccountManagerOrganization>

Defined in: packages/b2c-tooling-sdk/src/clients/am-api.ts:960

Get organization by name (searches for exact or partial match).

Parameters ​

name ​

string

Returns ​

Promise<AccountManagerOrganization>


listOrgs() ​

listOrgs(options?): Promise<OrganizationCollection>

Defined in: packages/b2c-tooling-sdk/src/clients/am-api.ts:965

List organizations with pagination.

Parameters ​

options? ​

ListOrgsOptions

Returns ​

Promise<OrganizationCollection>

Released under the Apache-2.0 License.