This is an archive version of the document. To get the most up-to-date information, see the current version.Modify User Data
You can update a user description and set a new password for a Veeam Backup for AWS user with the specified ID.
Request
To edit data for a specific user, send the HTTP PUT request to the /users/{userId} endpoint. {userId} is a user name of the Veeam Backup for AWS user.
HTTP Request
PUT https://<hostname>:<port>/api/v1/users/{userId} |
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 data to be changed for the user, send the following parameters in the request body.
Parameter | Required/Optional | Type | Description |
|---|---|---|---|
description | Optional | string | Specifies the new user description. |
password | Optional | string | Specifies the new password of the user. |
oldPassword | Required | string | Specifies the current password of the user. |
Note |
Before you change user data, you can check whether a 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:
{ "description": "string", "password": "string", "oldPassword": "string" } |
Response
The server returns the following response to the client.
Response Code
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 |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for AWS returns an updated representation of the user. The User schema is used for the resource representation.
Example
The following request sets a new description and password for a Veeam Backup for AWS user with the ID sara_baker.
|