Class PartnerRawClient

Low-level client for Partner API authorization and endpoint bindings.

Index

Constructors

constructor

Methods

authorizePartner createGroupMember ejectGroupMember listGroupMembers listGroups reserveTrialCreateAccount

Constructors

constructor

new PartnerRawClient(options: PartnerRawClientOptions): PartnerRawClient
Creates a new PartnerRawClient with the given transport.
Parameters
- options: PartnerRawClientOptions
  The constructor configuration.
Returns PartnerRawClient
- Defined in partner/raw.ts:359

Methods

authorizePartner

authorizePartner(
    masterKeyId: string,
    masterKey: string,
    realmUrl?: string,
    options?: PartnerRawRequestOptions,
): Promise<PartnerAuthorizeResponse>
Calls b2_authorize_account with Master Application Key credentials and normalizes the Partner/Backup suites into a Partner-specific auth shape.

The Partner API documentation currently shows the v3 authorize path, so this method intentionally uses /b2api/v3/b2_authorize_account while the storage raw client keeps using v4.
Parameters
- masterKeyId: string
  The Master Application Key ID for authentication.
- masterKey: string
  The Master Application Key secret.
- realmUrl: string = DEFAULT_PARTNER_REALM_URL
  The B2 realm URL to authenticate against.
- Optionaloptions: PartnerRawRequestOptions
  Optional abort and per-request retry settings.
Returns Promise<PartnerAuthorizeResponse>
The normalized Partner authorization response.

Throws
B2RealmConfigurationError if the realm URL is unsafe for Master Application Key credentials.

Throws
B2PartnerAuthorizationError if the response omits or returns unsafe Partner endpoint data.
- Defined in partner/raw.ts:394

createGroupMember

createGroupMember(
    groupsApiUrl: string,
    authToken: string,
    request: CreateGroupMemberRequest,
    options?: PartnerRawRequestOptions,
): Promise<CreateGroupMemberResult>
Calls b2_create_group_member.

The Partner API creates a new Backblaze account for an email address that is not already a Backblaze account and adds that account to the managed group. The wire response is a single JSON object.
Parameters
- groupsApiUrl: string
  The Partner API base URL from authorizePartner.
- authToken: string
  The Partner API authorization token.
- request: CreateGroupMemberRequest
  The group-member creation request body.
- Optionaloptions: PartnerRawRequestOptions
  Optional abort and per-request retry settings.
Returns Promise<CreateGroupMemberResult>
The created member result, including the member application key.
- Defined in partner/raw.ts:436

ejectGroupMember

ejectGroupMember(
    groupsApiUrl: string,
    authToken: string,
    request: EjectGroupMemberRequest,
    options?: PartnerRawRequestOptions,
): Promise<PartnerGroupMember>
Calls b2_eject_group_member.

Ejection removes the member account from the group but does not delete the Backblaze account. The wire response is a single JSON object.
Parameters
- groupsApiUrl: string
  The Partner API base URL from authorizePartner.
- authToken: string
  The Partner API authorization token.
- request: EjectGroupMemberRequest
  The group-member ejection request body.
- Optionaloptions: PartnerRawRequestOptions
  Optional abort and per-request retry settings.
Returns Promise<PartnerGroupMember>
The ejected member object.
- Defined in partner/raw.ts:470

listGroupMembers

listGroupMembers(
    groupsApiUrl: string,
    authToken: string,
    request: ListGroupMembersRequest,
    options?: PartnerRawRequestOptions,
): Promise<ListGroupMembersResult>
Calls b2_list_group_members.

Uses the documented canonical GET form. The wire response is a JSON array whose result objects surface nextEmail for cursor-based pagination.
Parameters
- groupsApiUrl: string
  The Partner API base URL from authorizePartner.
- authToken: string
  The Partner API authorization token.
- request: ListGroupMembersRequest
  The member listing query parameters.
- Optionaloptions: PartnerRawRequestOptions
  Optional abort and per-request retry settings.
Returns Promise<ListGroupMembersResult>
The group-member page result array.
- Defined in partner/raw.ts:581

listGroups

listGroups(
    groupsApiUrl: string,
    authToken: string,
    request: ListGroupsRequest,
    options?: PartnerRawRequestOptions,
): Promise<ListGroupsResult>
Calls b2_list_groups.

Uses the documented canonical GET form. The wire response is a single JSON object that surfaces nextGroupId for cursor-based pagination.
Parameters
- groupsApiUrl: string
  The Partner API base URL from authorizePartner.
- authToken: string
  The Partner API authorization token.
- request: ListGroupsRequest
  The group listing query parameters.
- Optionaloptions: PartnerRawRequestOptions
  Optional abort and per-request retry settings.
Returns Promise<ListGroupsResult>
The groups page object.
- Defined in partner/raw.ts:548

reserveTrialCreateAccount

reserveTrialCreateAccount(
    groupsApiUrl: string,
    authToken: string,
    request: ReserveTrialCreateAccountRequest,
    options?: PartnerRawRequestOptions,
): Promise<ReserveTrialCreateAccountResult>
Experimental
Calls b2_reserve_trial_create_account.

The Partner API creates one new Backblaze B2 account and starts a B2 Reserve trial for it. The wire request and success response are single JSON objects.

Each email address must not already be a Backblaze account. term is the trial duration in days, documented as 7 through 30 inclusive. storage is the requested storage in TB, documented as 1 through 50 inclusive.

This operation is non-idempotent and creates billable accounts. Automatic retries and expired-token reauthorization are disabled; long-lived callers must catch auth expiry, reauthorize, and then decide whether to issue a new request. A network or timeout failure after the server has processed the request may still have created an account, and the application key from a lost response is not recoverable from B2. Callers should reconcile account state out of band, such as through Partner account listing, before re-issuing a request for the same email address.
Parameters
- groupsApiUrl: string
  The Partner API base URL from authorizePartner. The authorize response currently exposes the shared Partner endpoint base as groupsApiUrl.
- authToken: string
  The Partner API authorization token.
- request: ReserveTrialCreateAccountRequest
  Email, term, storage, and optional region for the account to create.
- Optionaloptions: PartnerRawRequestOptions
  Optional abort and per-request retry settings.
Returns Promise<ReserveTrialCreateAccountResult>
The created reserve-trial account result.

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

Class PartnerRawClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns PartnerRawClient

Methods

authorizePartner

Parameters

Returns Promise<PartnerAuthorizeResponse>

Throws

Throws

createGroupMember

Parameters

Returns Promise<CreateGroupMemberResult>

ejectGroupMember

Parameters

Returns Promise<PartnerGroupMember>

listGroupMembers

Parameters

Returns Promise<ListGroupMembersResult>

listGroups

Parameters

Returns Promise<ListGroupsResult>

reserveTrialCreateAccount

Parameters

Returns Promise<ReserveTrialCreateAccountResult>

Settings

On This Page