Add Service Account Automtically

You can create a new service account automatically.

Request

To create a service account, send the HTTP POST request to the /accounts/azure/service/saveByToken endpoint.

HTTP Request

POST https://<hostname>/api/v2//accounts/azure/service/saveByToken

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 create a repository account, send the parameters of the CreateServiceAccountInfoV2 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",

 

   }

 }

}

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

  • application/json
  • application/problem+json

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 created service account. The CreateServiceAccountInfoV2 schema is used for the resource representation.

Save By TokenExample

The following request creates a service account with the following settings.

Request:

POST https://51.11.247.127/api/v2/policies

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

  "azureAuthenticationResult":{

     "authenticatedByCertificate":false,

     "azureEnvironment":"Global",

     "azureConnectionType":"Repository",

     "accessTokenCache":"AwAAAAEAAACRAWh0dHBzOi8vbG9naW4ud2luZG93cy5uZXQvZjhjZGVmMzEtYTMxZS00YjRhLTkzZTQtNWY1NzFlOTEyNTVhLzo6Omh0dHBzOi8vbWFuYWdlbWVudC5jb3JlLndpbmRvd3MubmV0Lzo6OjA0YjA3Nzk1LThkZGItNDYxYS1iYmVlLTAyZjllMWJmN2I0Njo6OjC2InsiUmF3Q2xpZW50SW5mbyI6ImV5SjFhV1FpT2lJd01EQXdNREF3TUMwd01EQXdMVEF3TURBdFpHSTFZeTFqWlRsak1XSTRNVEE1T1RNaUxDSjFkR2xrSWpvaU9URTRPREEwTUdRdE5tTTJOeTAwWXpWaUxXSXhNVEl0TXpaaE16QTBZalkyWkdGa0luMCIsIlJlZnJlc2hUb2tlbiI6IkFRQUJBQUFBQUFCZUFGekR3bGx6VFlHRExoX3FZYkg4cUdQdnRPRUN5TEpPUmVYVkYtVzd5dzNUM05mbHFTVzdGRC12S1NrOVZfUldNMGdST1I0X29hRjJqc2pLN1NVYUlJYkF0QzRsUk9EM3NFQzRISTR2NQSDkzWlZrYlRzZjg0RXlWbHdFSkNiYkEtQzNvQkpPOGVBeFZKT2luaWJHdHBxUzdmcHFEdmQ0TE9yY2R1SkxxZW13S21sQTFIdl9SY0dtbGVWZGExTUZ3Mk5PeVdiVFpSQlRHb3JjcEwtWnZnNGlGdGJ4WlNFWGdpSTZWOEJPVXFVdlRpOU9EdFBWMHRvSEUxaHNReHFpMXlHZyIsIkFjY2Vzc1Rva2VuVHlwZSI6IkJlYXJlciIsIkV4cGlyZXNPbiI6eyJEYXRlVGltZSI6IlwvRGF0ZSgxNTgwODA0NDYxNDc2KVwvIiwiT2Zmc2V0TWludXRlcyI6MH0sIkV4dGVuZGVkRXhwaXJlc09uIjp7IkRhdGVUaW1lIjoiXC9EYXRlKDE1ODA4MDQ0NjE0NzYpXC8iLCJPZmZzZXRNaW51dGVzIjowfSwiRXh0ZW5kZWRMaWZlVGltZVRva2VuIjpmYWxzZSwiSWRUb2tlbiI6ImV5SjBlWEFpT2lKS1YxUWlMQ0poYkdjaU9pSnViMjVsSW4wLmV5SmhkV1FpT2lJd05HSXdOemM1TlMwNFpHUmlMVFEyTVdFdFltSmxaUzB3TW1ZNVpURmlaamRpTkRZaUxDSnBjM01pT2lKb2RIUndjem92TDNOMGN5NTNhVzVrYjNkekxtNWxkQzltT0dOa1pXWXpNUzFoTXpGbExUUmlOR0V0T1RObE5DMDFaalUzTVdVNU1USTFOV0V2SWl3aWFXRjBJam94TlRnd09EQXdOVFl5TENKdVltWWlPakUxT0RBNE1EQTFOaklzSW1WNGNDSTZNVFU0TURnd05EUTJNaXdpWVd4MGMyVmphV1FpT2lJeE9teHBkbVV1WTI5dE9qQXdNRE0wTURBeFF6bEZOelV6UmtVaUxDSmhiWElpT2xzaWNIZGtJbDBzSW1WdFlXbHNJam9pVWtSRGJHOTFaQzVDWVdOcmRYQXVSR2wyTTBCMlpXVmhiUzVqYjIwaUxDSm1ZVzFwYkhsZmJtRnRaU0k2SWxsaGMzbDFheUlzSW1kcGRtVnVYMjVoYldVaU9pSkxiM04wZVdFaUxDSnBaSEFpT2lKc2FYWmxMbU52YlNJc0ltbHdZV1JrY2lJNklqVXhMakUwTVM0ek5TNHhNRE1pTENKemRXSWlPaUpUVVZCVlVEVnlZMU14Wm5ORGFsOW1TbnBVT0dvMk4zRlBVa3h3UTNSUFVFaHZWVzlpY2tscFdHUmpJaXdpZEdsa0lqb2laamhqWkdWbU16RXRZVE14WlMwMFlqUmhMVGt6WlRRdE5XWTFOekZsT1RFeU5UVmhJaXdpZFc1cGNYVmxYMjVoYldVaU9pSnNhWFpsTG1OdmJTTlNSRU5zYjNWa0xrSmhZMnQxY0M1RWFYWXpRSFpsWldGdExtTnZiU0lzSW5abGNpSTZJakV1TUNKOS4iLCJUZW5hbnRJZCI6ImY4Y2RlZjMxLWEzMWUtNGI0YS05M2U0LTVmNTcxZTkxMjU1YSIsIlVzZXJJbmZvIjp7IkRpc3BsYXlhYmxlSWQiOiJSRENsb3VkLkJhY2t1cC5EaXYzQHZlZWFtLmNvbSIsIkZhbWlseU5hbWUiOiJZYXN5dWsiLCJHaXZlbk5hbWUiOiJLb3N0eWEiLCJJZGVudGl0eVByb3ZpZGVyIjoibGl2ZS5jb20iLCJQYXNzd29yZENoYW5nZVVybCI6bnVsbCwiUGFzc3dvcmRFeHBpcmVzT24iOm51bGwsIlVuaXF1ZUlkIjoiU1FQVVA1cmNTMWZzQ2pfZkp6VDhqNjdxT1JMcEN0T1BIb1VvYnJJaVhkYyJ9fSwiVXNlckFzc2VydGlvbkhhc2giOm51bGx9",

     "displayableId":"@tech.com",

     "familyName":"Family Name",

     "givenName":"Given Name",

     "identityProvider":"live.com",

     

     }

  },

  "adGroupSettings": {

   "groupIdToAdd": "null",

   "groupNameToAdd": "null"

 

 },

 

  "serviceAccount":{

     "description":"created by admin",

     "name":"Service Account"

  },

 

 

Response:

200

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.