Create User

You can create a new Veeam Backup for Microsoft Azure user.

Request

To create a user, send the HTTP POST request to the /users endpoint.

HTTP Request

POST https://<hostname>:<port>/api/v2/users

Request Headers

The request contains the following headers.

Header

Required

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

Request Body

To specify credentials and description of the created user, send the following required parameters in the request body.

Parameter

Type

Description

name

string

Specifies a user name of the new user.

description

string

Specifies a user description of the new user.

password

string

Specifies a password of the new user.

Set the parameter values in the following format:

{

 "name": "string",

 "description": "string",

 "password": "string"

}

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 HTTP headers.

Header

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns a representation of the created user. The UserV2 schema is used for the resource representation.

Create UserExample

The following request creates a new Veeam Backup for Microsoft Azure user.

Request:

POST https://51.11.247.127/api/v2/users

 

Request Header:

Authorization: Bearer <Access-Token>

Content-Type: application/json

 

Request Body:

{

 "name": "jack_parker",

 "description": "Dept-02 user",

 "password": "Administrator"

}

 

Response:

200

 

Response Body:

{

 "id": "1003",

 "name": "jack_parker",

 "description": "Dept-02 user",

 "mfaEnabled": false,

 "isDefault": false,

 "_links": {

   "self": {

     "href": "https://51.11.247.127/api/v2/users/1003"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.