This is an archive version of the document. To get the most up-to-date information, see the current version.Getting Licensed Users
You can get a resource representation of information about the licensed users.
Request
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following optional parameters can be specified in the URL of the request:
Parameter | Type | Description |
|---|---|---|
organizationId | string | Specifies the ID of the organization for which the server will return information about licensed users. If you do not specify this parameter, the server will return a representation of licensed users of all organizations added in Veeam Backup for Microsoft 365. For more information on how to get this parameter, see Getting Organizations. |
name | string | Specifies the name of the licensed user for which the server will return information. If you do not specify this parameter, the server will return a representation of all licensed users in Veeam Backup for Microsoft 365. |
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 /LicensedUsers collection resource. The response body contains the following properties:
Property | Type | Description |
|---|---|---|
offset | integer | Specifies the offset value. |
limit | integer | Specifies the limit of records to be displayed on the page. |
id | string | ID of the licensed user. |
name | string | Name of the licensed user. |
isBackedup | boolean | Defines whether the user was 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:
|
organizationId | string | ID of the backed-up organization. |
backedUpOrganizationId | string | ID of the backed-up organization in the backup. |
organizationName | string | Name of the backed-up organization. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
The example returns a resource representation of information about licensed users.
Request: GET https://abc.tech.local:4443/v6/LicensedUsers
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "offset": 0, "limit": 30, "results": [ { "id": "fc7e8d65-2266-453a-b0f7-686c7752fde4:00000000-0000-0000-0000-000000000000", "name": "admin@abc.onmicrosoft.com", "isBackedup": true, "lastBackupDate": "2020-11-17T22:01:09.1167797Z", "licenseState": "Licensed", "organizationId": "967093a9-cf39-43e5-84cb-646ccd4993df", "backedUpOrganizationId": "abc.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000", "organizationName": "abc.onmicrosoft.com", "_links": { "organization": { "href": "/v6/organization/967093a9-cf39-43e5-84cb-646ccd4993df" } } } ], "_links": { "self": { "href": "/v6/LicensedUsers?offset=0&limit=30" } } } |
