Licensed Users

The /LicensedUsers resource collection represents information about the licensed users in Veeam Backup for Microsoft 365.

Get Licensed Users

Returns a collection of information about the licensed users.

SecurityBearer

Request

query Parameters

limit	integer <int32> Limits the maximum number of items that the server will return on a page. The maximum supported number of items per page is 10,000. The default value is 30.
offset	integer <int32> Excludes from a response page the first N items of a collection resource. The default value is 0.
organizationId	string Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Get Organizations.
backedUpOrganizationId	string Specifies the identification number of the backed-up Microsoft organization in the backup. For more information on how to get this parameter, see Get Backed-Up 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. To filter objects, you can use * and ? wildcard characters.

Responses

200

default

Operation failure response.

get/v8/LicensedUsers

Request samples

curl
Python
JavaScript
C#
Go

Response samples

200
default

application/json

{"offset": 0,
"limit": 0,
"setId": "83e19bc1-5428-42b5-88ea-b28354e481f3",
"results": [{"id": "string",
"name": "string",
"isBackedUp": true,
"lastBackupDate": "2019-08-24T14:15:22Z",
"licenseState": "Licensed",
"organizationId": "00000000-0000-0000-0000-000000000000",
"backedUpOrganizationId": "string",
"organizationName": "string",
"_links": {"property1": {"href": "string"
},
"property2": {"href": "string"
}
}
}
],
"_links": {"property1": {"href": "string"
},
"property2": {"href": "string"
}
}
}

Revoke License from Users

Removes information about a licensed user from Veeam Backup for Microsoft 365.

When you remove information about a licensed user, Veeam Backup for Microsoft 365 revokes the license from this user. You can use a unit in the license to back up data of other user in your Microsoft 365 organization.

NOTE
You cannot revoke a license from a user if a backup repository contains data of this user.

SecurityBearer

Request

path Parameters

licensedUserId

required

string

Specifies the identification number of the user for which you want to revoke the license. For more information on how to get this parameter, see Get Licensed Users.