Modify User Data
You can update a user description and set a new password for a Veeam Backup for Microsoft Azure user with the specified ID.
Request
To edit data for a specific user, send the HTTP PUT request to the /users/{id} endpoint. {id} is a user ID of the Veeam Backup for Microsoft Azure user.
HTTP Request
PUT https://<hostname>:<port>/api/v2/users/{id} |
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 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. |
Set the parameter values in the following format:
{ "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 |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for Microsoft Azure returns an updated representation of the user. The UserV2 schema is used for the resource representation.
Example
The following request sets a new description and password for a Veeam Backup for Microsoft Azure user with the ID 1003.
|