The resources in the /Users collection have a number of properties that reflect user characteristics in Veeam Availability Console. Properties can be used as query parameter values in GET requests.
Property | Type | Description |
|---|---|---|
id | integer | System ID assigned to a user in Veeam Availability Console RESTful API. |
firstName | string | User first name configured in Veeam Availability Console. |
lastName | string | User last name configured in Veeam Availability Console. |
userName | string | User login name assigned automatically or configured in Veeam Availability Console. |
role | string | User role in Veeam Availability Console. Possible values:
|
cloudRepositoryEnabled | boolean | Indicates whether cloud repository is enabled for a user. Only present if the role property has value Company User or Department User. |
title | string | User title. Possible values:
|
status | string | User status. Possible values:
|
string | User email address configured in Veeam Availability Console. | |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). Can contain links to locations and backup resources. |
User Backup Resources
If the cloudRepositoryEnabled property has value true, the /Users/{ID} resource has the /Users/{ID}/BackupResources sub-resource with the following properties:
Property | Type | Description |
|---|---|---|
id | integer | System ID assigned to a user backup resource in Veeam Availability Console RESTful API. |
quotaName | string | Name of a cloud repository configured for a user. |
storageQuota | integer | Amount of storage space allocated to a user. |
storageQuotaUnits | string | Measurement units for storage space allocated to a user. |
usedStorageQuota | integer | Amount of allocated storage space already used by a user. |
usedStorageQuotaUnits | string | Measurement units for storage space already used by a user. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
