This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Licensed Users

In this article

This section explains how to get a resource representation of licensed users information.

Request

GET https://<hostname>:4443/v4/LicensedUsers

Request Headers

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

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 the licensed user.
Name	string	Specifies the name of the licensed user.
IsBackedUp	boolean	If set to True, indicates that this user had already been processed by a backup job.
LastBackupDate	UTC	Specifies the time when the user was processed by a backup job for the last time.
LicenseState	licenseState	Specifies the current status of a license: Licensed Trial TemporarilyAssigned Exceeded
OrganizationId	string	Specifies the ID of an organization.
BackedUpOrganizationId	string	Specifies the ID of the backed-up organization.
OrganizationName	string	Specifies the name of the backed-up organization.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

Example

The example below returns an entity representation of the licensed users information.

Request:

GET https://abc.tech.local:4443/v4/LicensedUsers

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"id": "93089cfa-81d6-4551-8a7b-a7290868d6f9",

"name": "User ABC",

"isBackedUp": "true",

"lastBackupDate": "2017-11-05T17:50:35",

"licenseState": "licensed",

"organizationId": "feccc769-5f39-4797-8918-96df38908a90",

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

"organizationName": "Organization ABC",

}