Getting Backup Accounts

In this article

    You can get a list of backup accounts configured for Microsoft 365 organizations to minimize throttling when backing up Microsoft SharePoint and OneDrive for Business items.

    Request

    GET https://<hostname>:4443/v6/Organizations/{organizationId}/BackupAccounts

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Parameters

    The following parameter must be specified in the URL of the request:

    Parameter

    Type

    Description

    organizationId

    string

    Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Getting Organizations.

    Request Body

    None.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the response body message: application/json; charset=utf-8

    Response Body

    The response body contains the following properties:

    Property

    Type

    Description

    groupMember

    groupMemberObject

    Specifies properties of a group to which the account belongs.

    password

    string

    Specifies the password, if exist.

    groupMemberObject

    Property

    Type

    Description

    groupId

    string

    Specifies an identification number of the group to which the account belongs.

    name

    string

    Specifies the account name.

    login

    string

    Specifies the account login.

    type

    string

    Specifies the user account type. The following types are available:

    • Unknown
    • User
    • Group

    isCloud

    boolean

    Defines whether the account belongs to the Microsoft Online group, not on-premises.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Example

    The example shows how to get a list of backup accounts configured for the Microsoft organization with the ID 6f9b3da3-204d-4a4b-b466-55586e0233fc.

    Request:

    GET https://abc.tech.local:4443/v6/Organizations/6f9b3da3-204d-4a4b-b466-55586e0233fc/backupaccounts

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    [

      {"groupMember":    {

         "groupId": "6e570850-9ce9-40ed-b81d-41772dabcead00000000-0000-0000-0000-000000000000",

         "login": "account1@office365.onmicrosoft.com",

         "type": "User",

         "isCloud": true,

         "_links": {"organization": {"href": "/v6/organizations/6f9b3da3-204d-4a4b-b466-55586e0233fc"}}

      }},

      {"groupMember":    {

         "groupId": "6e570850-9ce9-40ed-b81d-41772dabcead00000000-0000-0000-0000-000000000000",

         "login": "account2@office365.onmicrosoft.com",

         "type": "User",

         "isCloud": true,

         "_links": {"organization": {"href": "/v6/organizations/6f9b3da3-204d-4a4b-b466-55586e0233fc"}}

      }},

      {"groupMember":    {

         "groupId": "6e570850-9ce9-40ed-b81d-41772dabcead00000000-0000-0000-0000-000000000000",

         "login": "account3@office365.onmicrosoft.com",

         "type": "User",

         "isCloud": true,

         "_links": {"organization": {"href": "/v6/organizations/6f9b3da3-204d-4a4b-b466-55586e0233fc"}}

      }},

      {"groupMember":    {

         "groupId": "6e570850-9ce9-40ed-b81d-41772dabcead00000000-0000-0000-0000-000000000000",

         "login": "account4@office365.onmicrosoft.com",

         "type": "User",

         "isCloud": true,

         "_links": {"organization": {"href": "/v6/organizations/6f9b3da3-204d-4a4b-b466-55586e0233fc"}}

      }}

    ]