This is an archive version of the document. To get the most up-to-date information, see the current version.Modify User
You can modify a user with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.
Request
To modify a user, send the PATCH HTTP request to the URL of the /users/{userUid} resource.
HTTP Request
PATCH https://<hostname>:1280/api/v3/users/{userUid} |
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. |
Content-Type | Required | application/json | Identifies a media type that is used in the body of the request. |
Accept | Optional | application/json | 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 parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
userUid | Path | String (uuid) | Yes | — | User UID |
Body | Body | Array (JSON Patch) | Yes | — | Array of JSON Patch operations according to RFC 6902 |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns 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 | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns modified resource representation based on the User schema.
Example 
The following request disabled a user with UID dc238b46-2cbb-4620-8838-806e5b28cacb.
Request: PATCH https://localhost:1280/api/v3/users/dc238b46-2cbb-4620-8838-806e5b28cacb
Request Header: Content-type: application/json Authorization: Bearer <Access-Token>
Request Body: [ { "op": "replace", "value": "disabled", "path": "/status" } ]
Response Code: 200 OK Response Body: { "data": { "instanceUid": "dc238b46-2cbb-4620-8838-806e5b28cacb", "organizationUid": "b10d5f94-9bd0-4d3f-b11f-35c453d4d4cb", "userName": "Alpha", "status": "disabled", "role": "companyOwner", "profile": { "firstName": null, "lastName": null, "title": "mr", "email": null, "address": null, "phone": null }, "credentials": { "userName": "Alpha", "password": null } } } |