This is an archive version of the document. To get the most up-to-date information, see the current version.Create User
You can create a new Veeam Backup for AWS user.
Request
To create a user, send the HTTP POST request to the /users endpoint.
HTTP Request
POST https://<hostname>:<port>/api/v1/users |
Request Headers
The request contains the following headers.
Header | Required/Optional | 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. |
x-api-version | Required | 1.0-rev0 | Specifies the current revision of the Veeam Backup for AWS REST API. |
Content-Type | Required | application/json | Identifies a media type that is used in the body of the request. |
Accept | Optional |
| Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
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. |
Note |
Before you create a new user, you can check whether a user name, user description and password you plan to specify meet the Veeam Backup for AWS requirements. For more information, see the Validate User Name, Validate Password and Validate User Description sections in the REST API Reference. |
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 Code
A successfully completed operation returns a response code 201 (Created).
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 |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for AWS returns a representation of the created user. The User schema is used for the resource representation.
Example
The following request creates a new Veeam Backup for AWS user.
|