This is an archive version of the document. To get the most up-to-date information, see the current version.Edit Automatically Created Service Account
You can update a service account with the specified ID.
Request
To update a service account settings, send the HTTP PUT request to the /accounts/azure/service/updateByToken/{accountId} endpoint. {accountId} is a system ID assigned to the service account in the Veeam Backup for Microsoft Azure REST API.
HTTP Request
PUT https://<hostname>/api/v3/accounts/azure/service/updateByToken/{accountId} |
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 update the service account settings, send the parameters of the CreateServiceAccountInfov3 schema in the request body.
Note |
To obtain an accessTokenCache, follow the instructions in section Authenticate Service Account . |
{ "serviceAccount": { "name": "string", "description": "string" }, "adGroupSettings": { "groupIdToAdd": "string", "groupNameToAdd": "string", "groupIdToRemove": "string" }, "azureAuthenticationResult": { "authenticatedByCertificate": true, "azureEnvironment": "Global", "azureAccountPurpose": "Service", "accessTokenCache": "string", "displayableId": "string", "familyName": "string", "givenName": "string", "identityProvider": "string", "tenantId": "string", "_links": { "additionalProp1": { "href": "string" }, "additionalProp2": { "href": "string" }, "additionalProp3": { "href": "string" } } } } |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 204 (No Content).
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 a 204 Code.
Example
The following request updates a service account with the ID 1.
|