Authenticate Service Account
You can authenticate a service account.
Request
To authenticate a service account, send the HTTP POST request to the /accounts/azure/service/authenticate endpoint.
HTTP Request
POST https://<hostname>/api/v2/accounts/azure/service/authenticate |
Note |
If you authenticate to edit an existing account enter a system ID of an account you want to edit. To do that, specify the editAccount parameter after the endpoint of the request URL: ?editAccount=142. |
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 authenticate a service account, send the parameters of the DeviceLoginParametersV2 schema in the request body.
Note |
To obtain a userCode, deviceCode and verification URL requires for authentication, follow the instructions in section Get Device Authentication Code. |
{ "azureEnvironment": "Global", "userCode": "string", "deviceCode": "string", "verificationUrl": "string", "expiresOn": "2020-12-02T02:23:32.156Z", "interval": 0, "message": "string", "clientId": "string", "resource": "string", "azureAccountPurpose": "Service" } |
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 a representation of the /accounts/azure/service/authenticate collection. The AzureAuthenticationResultV2 schema is used for the collection representation.
Example
The following request returns an authentication result
|