b2_create_group_member
    • Dark
      Light

    b2_create_group_member

    • Dark
      Light

    Article summary

    Post
    /b2api/v3/b2_create_group_member

    Creates a new Backblaze account and adds the new accounts to a Group as a Group member.

    The email for the new Group member must not already exist as a Backblaze account. Note: A Backblaze Group member account can only be a member of one Group at a time. The email does not have to be a "real" email address, but must be in the format of one. The new Backblaze account will not be able to log in to Backblaze once created, but can only be managed by the Group admin account from the Group admin's Group Management page. Due to these restrictions, the Group that the new account is being added to is required to be a managed Group with Backblaze B2 enabled as a Group product. The new Group member will be provided with the same services enabled on the Group to which they are being added.

    There is a limit of 5,000 Group members per Group.

    Header parameters
    Authorization
    stringRequired

    An account authorization token, obtained from b2_authorize_account.

    Body parameters
    object
    adminAccountId
    string Required

    The accountId of the Group admin. This account must be authorized for the Partner API.

    ExampleadminAccountId
    groupId
    string Required

    The Group ID to which the new Backblaze account will be added. The Group must be enabled for Group admin management and have the Backblaze B2 product enabled.

    ExamplegroupId
    memberEmail
    string Required

    The new Group member's email address.

    Email addresses cannot already be an existing Backblaze account. If the Group is enabled for SSO login, the email address must belong to the SSO domain.

    region
    string

    The region that the new Backblaze account's data will reside in. If null, the current default region for new accounts will be used. Valid options are "us-east", "us-west" or "eu-central".

    Exampleus-west
    Responses
    200

    The request succeeded.

    Array of object
    object
    applicationKeyId
    string

    The Backblaze B2 applicationKeyId for the new Group member, required for the call to b2_authorize_account.

    Example100530e11d8c4a80000000001
    applicationKey
    string

    The Backblaze B2 applicationKey for the new Group member, required for the call to b2_authorize_account.

    ExampleK100wD6xncrkDb+cfSaog+HkrrzKtsI
    groupMember
    accountId
    string

    The accountId for the Group member.

    ExampleYOUR_ACCOUNT_ID
    email
    string

    The email address of the Group member account.

    groupId
    string

    The unique ID of the Group to which the new account was added as a member.

    Example4a48fe8875c6214145260818
    groupName
    string

    The Group name of the Group to which the new account was added as a member.

    ExamplePartner Group 2
    region
    string

    The region in which the Group member's account data will reside.

    Exampleus-west
    s3Endpoint
    string

    The end point domain for the Backblaze S3 Compatible API. The end point has the format s3.us-west-NNN.backblazeb2.com or s3.eu-central-NNN.backblazeb2.com

    Examples3.us-west-NNN.backblazeb2.com
    400
    statuscodedescription
    400bad_requestThe request had the wrong fields or illegal values. The message returned with the error will describe the problem.
    object
    status
    integer

    The numeric HTTP status code. Always matches the status in the HTTP response.

    Example400
    code
    string

    A single-identifier code that identifies the error.

    Exampleinvalid_bucket_name
    message
    string

    A human-readable message, in English, saying what went wrong.

    Examplebucket name is too long
    401
    statuscodedescription
    401too_many_membersThe Group is already at the maximum Group member count.
    401invalid_group_idThe groupId is invalid, the Group has been deleted, the Group admin is not a Group admin for the Group.
    401invalid_emailThe Group member's email is an invalid email or already exists as a Backblaze account.
    401invalid_regionThe region, if provided, is not a valid Backblaze region.
    401invalid_sms_phoneThe Group Admin must have a valid SMS phone number on their account to create Group members.
    401unauthorizedThe auth token used is valid, but does not authorize this call with these parameters. The capabilities of an auth token are determined by the Application Key used with b2_authorize_account.
    401bad_auth_tokenThe auth token used is not valid. Call b2_authorize_account again to either get a new one, or an error message describing the problem.
    401expired_auth_tokenThe auth token used has expired. Call b2_authorize_account again to get a new one.
    401method_failureThe process for adding a new Group member did not successfully complete. When this occurs, a background process will be started to fully back out the Group member and delete the account. After the background process completes, creating the new Group member can be retried. Please verify the state of the new Group member and their Backblaze account before retrying.

    Was this article helpful?