Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Users

The /users resource collection represents users added to Veeam Backup for Microsoft Azure.

Get Collection of Users

The HTTP GET request to the /users endpoint retrieves a list of all users added to the Veeam backup for Microsoft Azure configuration database.

SecurityBearer
Request
query Parameters
NameFilter
string or null

Returns only a user with the specified name.

x-veeam-parameter-group: UserQueryOptions
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/users
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/users?NameFilter=string&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Add User

The HTTP POST request to the /users endpoint creates a new user account in Veeam backup for Microsoft Azure.

SecurityBearer
Request
Request Body schema: application/json
required
name
required
string

Specifies a name for the new user.

description
required
string

Specifies a description for the new user.

role
string or null (RbacRoleNullable)

Specifies the role to assign to the user.

Enum: "PortalAdmin" "PortalOperator" "RestoreOperator" "VeeamUpdater" "Unknown" "IntegrationOperator" "ReadOnlyUser"
x-external-type: Veeam.Azure.REST.Latest.RbacRole
type
string or null (UserTypeNullable)

Specifies the type of the new user.

Enum: "Internal" "IdentityProvider" "Unknown"
x-external-type: Veeam.Azure.REST.Latest.UserType
identityProviderEntityId
string or null

Specifies the Microsoft Azure ID assigned to the identity provider entity of the new user.

password
string or null

Specifies a password of the new user.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

post/api/v8/users
Request samples
application/json
{
  • "role": "PortalAdmin",
  • "type": "Internal",
  • "identityProviderEntityId": "string",
  • "name": "string",
  • "description": "string",
  • "password": "string"
}
Response samples
application/json
{
  • "role": "PortalAdmin",
  • "type": "Internal",
  • "identityProviderEntityId": "string",
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "mfaEnabled": true,
  • "isDefault": true,
  • "_links": {}
}

Get User Data

The HTTP GET request to the /users/{id} endpoint retrieves information on a user with the specified ID.

SecurityBearer
Request
path Parameters
id
required
string or null

Specifies the system ID assigned to a user in the Veeam Backup for Microsoft Azure REST API.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/users/{id}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/users/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "role": "PortalAdmin",
  • "type": "Internal",
  • "identityProviderEntityId": "string",
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "mfaEnabled": true,
  • "isDefault": true,
  • "_links": {}
}

Modify User

The HTTP PUT request to the /users/{id} endpoint updates settings of a user with the specified ID.

SecurityBearer
Request
path Parameters
id
required
string or null

Specifies the system ID assigned to a user in the Veeam Backup for Microsoft Azure REST API.

Request Body schema: application/json
required
role
string or null (RbacRoleNullable)

Specifies the role to assign to the user.

Enum: "PortalAdmin" "PortalOperator" "RestoreOperator" "VeeamUpdater" "Unknown" "IntegrationOperator" "ReadOnlyUser"
x-external-type: Veeam.Azure.REST.Latest.RbacRole
name
string or null

Specifies a new name for the user.

description
string or null

Specifies a new description for the user.

password
string or null

Specifies a new password for the user.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Client Error

put/api/v8/users/{id}
Request samples
application/json
{
  • "role": "PortalAdmin",
  • "name": "string",
  • "description": "string",
  • "password": "string"
}
Response samples
application/json
{
  • "role": "PortalAdmin",
  • "type": "Internal",
  • "identityProviderEntityId": "string",
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "mfaEnabled": true,
  • "isDefault": true,
  • "_links": {}
}

Remove User

The HTTP DELETE request to the /users/{id} endpoint removes a user with the specified ID from the Veeam Backup for Microsoft Azure configuration database.

SecurityBearer
Request
path Parameters
id
required
string or null

Specifies the system ID assigned to a user in the Veeam Backup for Microsoft Azure REST API.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

delete/api/v8/users/{id}
Request samples 
curl -i -X DELETE \
  'https://123.123.123.123/api/v8/users/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "status": 0,
  • "title": "string",
  • "traceId": "string",
  • "type": "string"
}

Change User Password

The HTTP POST request to the /users/{userId}/changePassword endpoint changes password of a user with the specified ID.

SecurityBearer
Request
path Parameters
userId
required
string or null

Specifies the system ID assigned to a user in the Veeam Backup for Microsoft Azure REST API.

Request Body schema: application/json
required
adminsPassword
required
string non-empty

Specifies the password of the Default Admin.

newPassword
required
string non-empty

Specifies a new password for the user.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

post/api/v8/users/{userId}/changePassword
Request samples
application/json
{
  • "newPassword": "string",
  • "adminsPassword": "string"
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}

Get MFA Secret Key

The HTTP POST request to the /users/{id}/enableMfa endpoint retrieves an MFA secret key and a token used to associate an authenticator application with the authorization server. For more information on how to enable MFA for a user, see the Veeam Backup for Microsoft Azure REST API Reference Overview, section Multi-Factor Authentication.

SecurityBearer
Request
path Parameters
id
required
string or null

Specifies the system ID assigned to a user in the Veeam Backup for Microsoft Azure REST API.

Request Body schema: application/json
required
recreate
boolean

Defines whether you want to recreate the existing MFA secret key (true) or to enable MFA for the user (false).

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Client Error

post/api/v8/users/{id}/enableMfa
Request samples
application/json
{
  • "recreate": true
}
Response samples
application/json
{
  • "userId": "string",
  • "qrString": "string",
  • "secretKey": "string",
  • "scratchCodes": [
    ],
  • "token": "string"
}

Disable MFA for User

The HTTP POST request to the /users/{id}/disableMfa endpoint disables MFA for a specific user.

SecurityBearer
Request
path Parameters
id
required
string or null

Specifies the system ID assigned to a user in the Veeam Backup for Microsoft Azure REST API.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v8/users/{id}/disableMfa
Request samples 
curl -i -X POST \
  'https://123.123.123.123/api/v8/users/{id}/disableMfa' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "status": 0,
  • "title": "string",
  • "traceId": "string",
  • "type": "string"
}

Enable MFA for User

The HTTP POST request to the /api/v1/users/{id}/acceptMfa endpoint assosiates an authenticator application with the authorization server. For more information on how to enable MFA for a user, see the Veeam Backup for Microsoft Azure REST API Reference Overview, section Multi-Factor Authentication.

SecurityBearer
Request
path Parameters
id
required
string or null

Specifies the system ID assigned to a user in the Veeam Backup for Microsoft Azure REST API.

Request Body schema: application/json
required
code
required
string non-empty

Specifies the six-digit verification code generated by an authenticator application on the trusted device.

token
required
string non-empty

Specifies the token previously received from the authorization server.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Client Error

post/api/v8/users/{id}/acceptMfa
Request samples
application/json
{
  • "code": "string",
  • "token": "string"
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}

Export Collection of Users

The HTTP POST request to the /users/export endpoint exports a list of user accounts created in Veeam Backup for Microsoft Azure to a .CSV or an .XML file.

x-veeam-custom-response: true
SecurityBearer
Request
header Parameters
Accept
string or null

Specifies a media type of representation of the exported data. The default value is text/csv media type.

Request Body schema: application/json
nameFilter
string or null

Returns only a user with the specified name.

userIds
Array of strings or null <uuid>

Specifies the system IDs assigned in the Veeam Backup for Microsoft Azure REST API to the user accounts whose data will be exported.

Responses
200

OK

401

Unauthorized

403

Forbidden

post/api/v8/users/export
Request samples
application/json
{
  • "nameFilter": "string",
  • "userIds": [
    ]
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "licenseAgreementAcceptanceRequired": true
}

Change Password of Current User

The HTTP POST request to the /users/changePassword endpoint changes the password of a user that is currently authorized in the Veeam Backup for Microsoft Azure REST API.

SecurityBearer
Request
Request Body schema: application/json
required
currentPassword
string or null

Specifies the current password of the currently authorized user.

newPassword
string or null

Specifies a new password for the currently authorized user.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

post/api/v8/users/changePassword
Request samples
application/json
{
  • "currentPassword": "string",
  • "newPassword": "string"
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}