Contents x
b2_eject_group_member
    • Print
    • Dark
      Light
    Contents

    b2_eject_group_member

      • Print
      • Dark
        Light
      Article Summary

      Post
      /b2api/v3/b2_eject_group_member

      Ejects a Group member from a Group.

      Ejecting a Group member will not delete the Backblaze account, but will remove the account from the Group. Ejected Group members will need to reset their password when they next log in, and agree to the Backblaze Terms of Service. Any existing application keys created within the Group member's account will continue to be functional.

      The ejected Group member cannot be re-added to any Group using the Partner API, however, the account can be invited to join any Group from the Group Management page. If re-invited to join a Group, the Group member's email address cannot be further changed should they be ejected using this API.

      Warning

      Ejected Group members will need to reset their password when they next log in and agree to the Backblaze Terms of Service.

      Please confirm that the new email account passed to the email parameter is a valid email account. If the email parameter is null, please confirm that the current email account associated with the Group member is valid.

      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.

      ExampleADMIN_ACCOUNT_ID
      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.

      ExampleGROUP_ID
      memberAccountId
      string Required

      The accountId for the Group member who is being ejected and must be a member of the group identified by the GroupId.

      ExampleMEMBER_ACCOUNT_ID
      email
      string

      If different from the Group member’s email address, is a valid email, and doesn’t already exist as a Backblaze account, the email address to change the Group member to after ejecting them from the Group. If null, the email address of the Group member will not be changed.

      Example[email protected]
      Responses
      200

      The request succeeded.

      Array of object
      object
      accountId
      string

      The accountId for the Group member.

      ExampleYOUR_ACCOUNT_ID
      groupId
      string

      The unique ID of the Group from which the account was ejected.

      Example4a48fe8875c6214145260818
      groupName
      string

      The Group name of the Group from which the account was ejected.

      ExamplePartner Group 2
      email
      string

      The email address of the Group member account.

      Example[email protected]
      region
      string

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

      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
      401invalid_member_account_idThe member account Id is not a valid accountId, or is not a member of the Group for the groupId provided.
      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.
      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.
      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.
      Was this article helpful?
      What's Next