Getting User Data by Repository and User ID

In this article

This section explains how to get backed-up user data with the specified ID which is stored in a backup repository with the specified ID.

Request

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

Request Headers

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

Request Parameters

The following parameters must be specified in the URL of the request.

Parameter	Type	Description
repositoryId	string	An identification number of the backup repository.
userId	string	An identification number of the user.

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

Property	Type	Description
id	string	Specifies the ID of a backed-up organization.
accountId	string	Specifies the ID of a backed-up user.
displayName	string	Specifies the name of the backed-up user.
email	string	Specifies the email of the specified user.
oneDriveUrl	string	Specifies the URL for the backed-up users Microsoft OneDrive components.
personalSiteUrl	string	Specifies the URL for the backed-up users Microsoft SharePoint sites.
organizationId	string	Specifies the ID of a backed-up organization.

Example

The example below returns a resource representation of the backed-up user data having an 5c46c152-61b8-4d6c-9746-648aea7eccec ID.

Request:

GET https://abc.tech.local:4443/v5/BackupRepositories/459684e0-cb24e-4364-8b3c-e3aaeab4fb41/UserData/organization.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-0000000000005c46c152-61b8-4d6c-9746-648aea7eccec:00000000-0000-0000-0000-000000000000

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"isMailboxBackedUp": true,

"isOneDriveBackedUp": true,

"isArchiveBackedUp": false,

"isPersonalSiteBackedUp": true,

"accountType": "User",

"archiveName": "",

"id": "organization.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-0000000000005c46c152-61b8-4d6c-9746-648aea7eccec:00000000-0000-0000-0000-000000000000",

"accountId": "5c46c152-61b8-4d6c-9746-648aea7eccec:00000000-0000-0000-0000-000000000000",

"displayName": "…",

"email": "user@organization.onmicrosoft.com",

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

"oneDriveUrl": [

"https://organization-my.sharepoint.com/personal/.._organization_onmicrosoft_com/Documents"

"personalSiteUrl": [

"https://organization-my.sharepoint.com/personal/.._organization_onmicrosoft_com"

"_links": {

"self": {

"href": "https://127.0.0.1:4443/v5/backuprepositories/459684e0-ca4e-4164-8c3c-e3aaeab4fb41/userdata/5c46c152-61b8-4d6c-9746-648aea7eccec:00000000-0000-0000-0000-000000000000"

"organization": {

"href": "https://127.0.0.1:4443/v5/backuprepositories/459684e0-ca4e-4164-8c3c-e3aaeab4fb41/organizationdata/organization.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000"

"backupRepository": {

"href": "https://127.0.0.1:4443/v5/backuprepositories/459684e0-ca4e-4164-8c3c-e3aaeab4fb41"

}