Properties

In this article

    The resources in the /users collection have a number of properties that reflect user characteristics in Veeam Service Provider Console. Properties can be used as query parameter values in GET requests.

    Property

    Type

    Description

    id

    integer

    System ID assigned to a user in the Veeam Service Provider Console REST API.

    firstName

    String

    User first name configured in Veeam Service Provider Console.

    lastName

    String

    User last name configured in Veeam Service Provider Console.

    userName

    String

    User login name assigned automatically or configured in Veeam Service Provider Console.

    role

    String

    User role in Veeam Service Provider Console.

    Possible values:

    • Portal Administrator
    • Portal Operator
    • Site Administrator
    • Company Owner
    • Location Administrator
    • Location User
    • Subtenant
    • Invoice Auditor
    • Service Provider Global Administrator

    title

    String

    User title.

    Possible values:

    • Mr.
    • Miss
    • Mrs.
    • Ms.

    status

    String

    User status.

    Possible values:

    • Enabled
    • Disabled

    email

    String

    User email address configured in Veeam Service Provider Console.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property). Can contain links to locations and backup resources.

    This property can be excluded from the response. For more information, see the SetLinks Custom Query Option (setLinks) section.

    User Backup Resources

    If the role property has value subtenant, 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 the Veeam Service Provider Console REST 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.

    Possible values: B (byte) and its multiples formed with metric prefixes.

    usedStorageQuota

    integer

    Amount of allocated storage space already used by a user.

    usedStorageQuotaUnits

    String

    Measurement units for storage space already used by a user.

    Possible values: B (byte) and its multiples formed with metric prefixes.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).