Getting List of Users by Repository ID

In this article

    You can get a list of users whose data is stored in a backup repository with the specified ID.

    Request

    GET https://<hostname>:4443/v5/BackupRepositories/{repositoryId}/UserData

    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

    repositoryId

    string

    An identification number of the backup repository.

    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

    In the response body, the server returns a resource representation of the /BackupRepositories/{repositoryId}/UserData resource.

    Examples

    Example 1

    The example below returns a resource representation of the users backed-up data which is stored on a Veeam Backup for Microsoft Office 365 repository with the specified ID.

    Request:

    GET https://abc.tech.local:4443/v5/BackupRepositories/459684e0-cb24e-4364-8b3c-e3aaeab4fb41/UserData

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    {

      "offset": 0,

      "limit": 30,

      "results":    [

               {

            "mailboxBackedUpTime": "2020-10-23T07:43:39.3674841Z",

            "isMailboxBackedUp": true,

            "isOneDriveBackedUp": false,

            "isArchiveBackedUp": false,

            "isPersonalSiteBackedUp": false,

            "accountType": "User",

            "archiveName": "",

            "id": "organization.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000d03e1081-5169-4ead-bc26-fddd02fe6d6b:00000000-0000-0000-0000-000000000000",

            "accountId": "d03e1081-5169-4ead-bc26-fddd02fe6d6b:00000000-0000-0000-0000-000000000000",

            "displayName": "John Doe",

            "email": "johndoe.onmicrosoft.com",

            "oneDriveUrl": [],

            "personalSiteUrl": [],

            "organizationId": "organization.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000",

            "_links":          {

               "self": {"href": "abc.tech.local:4443/v5/backuprepositories/33f739b7-ae46-4139-8c72-8516af8a6d3d/userdata/d03e1081-5169-4ead-bc26-fddd02fe6d6b:00000000-0000-0000-0000-000000000000"},

               "organization": {"href": "abc.tech.local:4443/v5/backuprepositories/33f739b7-ae46-4139-8c72-8516af8a6d3d/organizationdata/organization.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000"},

               "backupRepository": {"href": "https://abc.tech.local:4443/v5/backuprepositories/33f739b7-ae46-4139-8c72-8516af8a6d3d"}

            }

         },

               {

            "oneDriveBackedUpTime": "2020-10-23T07:41:24.2885467Z",

            "personalSiteBackedUpTime": "2020-10-23T07:46:01.6383669Z",

            "isMailboxBackedUp": false,

            "isOneDriveBackedUp": true,

            "isArchiveBackedUp": false,

            "isPersonalSiteBackedUp": true,

            "accountType": "User",

            "id": "abc.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000611bfdea-2fb8-47f6-870d-fedc379e3a84:00000000-0000-0000-0000-000000000000",

            "accountId": "611bfdea-2fb8-47f6-870d-fedc379e3a84:00000000-0000-0000-0000-000000000000",

            "displayName": "Jane Doe",

            "oneDriveUrl": ["https://abc-my.sharepoint.com/personal/dnikitin_abc_onmicrosoft_com/_catalogs/design"],

            "personalSiteUrl": ["https://abc-my.sharepoint.com/personal/dnikitin_abc_onmicrosoft_com"],

            "organizationId": "abc.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000",

            "_links":          {

               "self": {"href": "https://abc.tech.local:4443/v5/backuprepositories/33f739b7-ae46-4139-8c72-8516af8a6d3d/userdata/611bfdea-2fb8-47f6-870d-fedc379e3a84:00000000-0000-0000-0000-000000000000"},

               "organization": {"href": "abc.tech.local:4443/v5/backuprepositories/33f739b7-ae46-4139-8c72-8516af8a6d3d/organizationdata/abc.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000"},

               "backupRepository": {"href": "https://abc.tech.local:4443/v5/backuprepositories/33f739b7-ae46-4139-8c72-8516af8a6d3d"}

            }

         }

      ],

      "_links": {"self": {"href": "https://abc.tech.local:4443/v5/BackupRepositories/33f739b7-ae46-4139-8c72-8516af8a6d3d/userdata?offset=0&limit=30"}}

    }

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.