Class PartnerClient`Experimental`

High-level Partner API client for groups, members, and B2 Reserve trials.

Example

const partner = new PartnerClient({
  masterKeyId: process.env.B2_MASTER_KEY_ID,
  masterKey: process.env.B2_MASTER_KEY,
})
await partner.authorize()
for await (const group of partner.paginateGroups()) {
  console.log(group.groupName)
}

Partner API surface; shape may change as the Partner API docs evolve.

Index

Constructors

constructor

new PartnerClient(options: PartnerClientOptions): PartnerClient
Experimental
Creates a new PartnerClient. Call authorize before making API requests.
Parameters
- options: PartnerClientOptions
  Configuration including credentials, realm, and transport settings.
Returns PartnerClient
- Defined in partner/client.ts:270

Properties

`Readonly` `Experimental`partnerAccountInfo

partnerAccountInfo: PartnerAccountInfo

Partner authorization state storage (tokens, URLs, capabilities).

`Readonly` `Experimental`raw

raw: PartnerRawClient

Low-level client for direct Partner API calls.

`Readonly` `Experimental`urlGuard

urlGuard: UrlGuard | null

SSRF allow-list applied by the default transport. null when a custom transport was supplied; in that case the SDK does not own the guard.

Methods

authorize

authorize(options?: PartnerAuthorizeOptions): Promise<PartnerAuthorizeResponse>
Experimental
Authenticates with B2 Partner authorization and stores the authorization state.
Parameters
- Optionaloptions: PartnerAuthorizeOptions
  Optional abort signal.
Returns Promise<PartnerAuthorizeResponse>
The Partner authorization response containing tokens, URLs, and capabilities.

Partner API surface; shape may change as the Partner API docs evolve.
- Defined in partner/client.ts:286

createGroupMember

createGroupMember(
options: CreateGroupMemberOptions,
): Promise<CreateGroupMemberResult>
Experimental
Creates a new Backblaze account and adds it to a Partner group.

This mutation is non-idempotent. Automatic retries and expired-token reauthorization are disabled; long-running batch callers must catch token expiry, call authorize, and decide whether to issue a new request.
Parameters
- options: CreateGroupMemberOptions
  Group ID, member email, and optional region.
Returns Promise<CreateGroupMemberResult>
The created member result, including the member application key.

Partner API surface; shape may change as the Partner API docs evolve.
- Defined in partner/client.ts:410

ejectGroupMember

ejectGroupMember(options: EjectGroupMemberOptions): Promise<PartnerGroupMember>
Experimental
Ejects an active member from a Partner group without deleting the account.

This mutation is non-idempotent. Automatic retries and expired-token reauthorization are disabled; long-running batch callers must catch token expiry, call authorize, and decide whether to issue a new request.
Parameters
- options: EjectGroupMemberOptions
  Group ID, member account ID, and optional replacement email.
Returns Promise<PartnerGroupMember>
The ejected member object.

Partner API surface; shape may change as the Partner API docs evolve.
- Defined in partner/client.ts:440

listGroupMembers

listGroupMembers(
options: ListGroupMembersOptions,
): Promise<ListGroupMembersResult>
Experimental
Lists active members for a Partner group.
Parameters
- options: ListGroupMembersOptions
  Group ID plus optional pagination settings.
Returns Promise<ListGroupMembersResult>
A page of group-member results with an optional continuation cursor.

Partner API surface; shape may change as the Partner API docs evolve.
- Defined in partner/client.ts:350

listGroups

listGroups(options?: ListGroupsOptions): Promise<ListGroupsResult>
Experimental
Lists Partner groups for the authorized partner administrator account.
Parameters
- Optionaloptions: ListGroupsOptions
  Optional group filter and pagination settings.
Returns Promise<ListGroupsResult>
A page of Partner groups with an optional continuation cursor.

Partner API surface; shape may change as the Partner API docs evolve.
- Defined in partner/client.ts:299

paginateGroupMembers

paginateGroupMembers(
options: PaginateGroupMembersOptions,
): AsyncIterableIterator<ListedGroupMember>
Experimental
Async iterator that yields every active member for a Partner group.
Parameters
- options: PaginateGroupMembersOptions
  Group ID plus optional page size and abort signal.
Returns AsyncIterableIterator<ListedGroupMember>
An async iterable of ListedGroupMember entries.

Partner API surface; shape may change as the Partner API docs evolve.
- Defined in partner/client.ts:376

paginateGroups

paginateGroups(
options?: PaginateGroupsOptions,
): AsyncIterableIterator<PartnerGroup>
Experimental
Async iterator that yields every Partner group for the authorized account.
Parameters
- Optionaloptions: PaginateGroupsOptions
  Optional group filter, page size, and abort signal.
Returns AsyncIterableIterator<PartnerGroup>
An async iterable of PartnerGroup entries.

Partner API surface; shape may change as the Partner API docs evolve.
- Defined in partner/client.ts:325

reserveTrialAccount

reserveTrialAccount(
request: ReserveTrialCreateAccountRequest,
options?: ReserveTrialAccountOptions,
): Promise<ReserveTrialCreateAccountResult>
Experimental
Reserves a new B2 Reserve trial account.

This operation is non-idempotent and automatic retries/expired-token reauthorization are disabled at the raw layer. If the request fails after the server processes it, the returned application key may be unrecoverable; reconcile account state before reissuing a request for the same email.
Parameters
- request: ReserveTrialCreateAccountRequest
  Email, trial duration, storage, and optional region for the account to create.
- Optionaloptions: ReserveTrialAccountOptions
  Optional abort signal.
Returns Promise<ReserveTrialCreateAccountResult>
The created reserve-trial account result.

Partner API surface; shape may change as the Partner API docs evolve.
- Defined in partner/client.ts:472

reserveTrialAccounts

reserveTrialAccounts(
request: ReserveTrialCreateAccountRequest,
options?: ReserveTrialAccountOptions,
): Promise<ReserveTrialCreateAccountResult>
Experimental
Reserves a new B2 Reserve trial account.
Parameters
- request: ReserveTrialCreateAccountRequest
  Email, trial duration, storage, and optional region for the account to create.
- Optionaloptions: ReserveTrialAccountOptions
  Optional abort signal.
Returns Promise<ReserveTrialCreateAccountResult>
The created reserve-trial account result.

Deprecated
Use reserveTrialAccount. This plural alias is kept for callers that picked up the original experimental facade name.

Partner API surface; shape may change as the Partner API docs evolve.
- Defined in partner/client.ts:498

toJSON

toJSON(): PartnerClientJson
Experimental
Hides credentials and Partner tokens from JSON.stringify(client).

Returns PartnerClientJson
A redacted diagnostic object.
- Defined in partner/client.ts:510

toString

toString(): string
Experimental
Hides credentials and Partner tokens from default stringification.

Returns string
A short redacted label.
- Defined in partner/client.ts:526

Class PartnerClientExperimental

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PartnerClient

Properties

Readonly ExperimentalpartnerAccountInfo

Readonly Experimentalraw

Readonly ExperimentalurlGuard

Methods

authorize

Parameters

Returns Promise<PartnerAuthorizeResponse>

createGroupMember

Parameters

Returns Promise<CreateGroupMemberResult>

ejectGroupMember

Parameters

Returns Promise<PartnerGroupMember>

listGroupMembers

Parameters

Returns Promise<ListGroupMembersResult>

listGroups

Parameters

Returns Promise<ListGroupsResult>

paginateGroupMembers

Parameters

Returns AsyncIterableIterator<ListedGroupMember>

paginateGroups

Parameters

Returns AsyncIterableIterator<PartnerGroup>

reserveTrialAccount

Parameters

Returns Promise<ReserveTrialCreateAccountResult>

reserveTrialAccounts

Parameters

Returns Promise<ReserveTrialCreateAccountResult>

Deprecated

toJSON

Returns PartnerClientJson

toString

Returns string

Settings

On This Page

Class PartnerClient`Experimental`

`Readonly` `Experimental`partnerAccountInfo

`Readonly` `Experimental`raw

`Readonly` `Experimental`urlGuard