This is an archive version of the document. To get the most up-to-date information, see the current version.

(GET) /security/accounts/{ID}

On This Page

Returns an account having the specified ID. The account is added to Veeam Backup Enterprise Manager and is assigned a specific security role.

Request

To get an account having the specified ID, you need to send the GET HTTP request to the URL of the /security/accounts/{ID} resource.

HTTP Request

GET http://<Enterprise-Manager>:9399/api/security/accounts/{ID}

Request Header

The request contains the following headers:

Header

Required

Description

X-RestSvcSessionId

True

The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security.

Request Body

None.

Query Parameters

None.

 

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 200 Success.

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/xml.

Response Body

In the response body, Veeam Backup Enterprise Manager returns a representation of the /security/accounts/{ID} resource.

Example

A sample request below returns an account having ID fd4befd6-70c6-4b2f-a068-d1d9a61905a3:

Request:

GET http://localhost:9399/api/security/accounts/fd4befd6-70c6-4b2f-a068-d1d9a61905a3

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<EnterpriseAccount xmlns="http://www.veeam.com/ent/v1.0" Type="EnterpriseAccount" Href="http://localhost:9399/api/security/accounts/de19303b-bcf3-428b-b113-ac0b2cf46bd7?format=Entity" Name="BUILTIN\Users" UID="urn:veeam:EnterpriseAccount:de19303b-bcf3-428b-b113-ac0b2cf46bd7">
 <Links>
   <Link Rel="Alternate" Type="EnterpriseAccountReference" Href="http://localhost:9399/api/security/accounts/de19303b-bcf3-428b-b113-ac0b2cf46bd7" />
   <Link Rel="Down" Type="EnterpriseAccountInRoleList" Href="http://localhost:9399/api/security/accounts/de19303b-bcf3-428b-b113-ac0b2cf46bd7/roles" />
   <Link Rel="Create" Type="EnterpriseAccountInRole" Href="http://localhost:9399/api/security/accounts/de19303b-bcf3-428b-b113-ac0b2cf46bd7/roles" />
   <Link Rel="Down" Type="EnterpriseAccountHierarchyScopeList" Href="http://localhost:9399/api/security/accounts/de19303b-bcf3-428b-b113-ac0b2cf46bd7/scopes" />
   <Link Rel="Create" Type="EnterpriseAccountHierarchyScope" Href="http://localhost:9399/api/security/accounts/de19303b-bcf3-428b-b113-ac0b2cf46bd7/scopes" />
   <Link Rel="Delete" Href="http://localhost:9399/api/security/accounts/de19303b-bcf3-428b-b113-ac0b2cf46bd7" />
   <Link Rel="ToggleRestoreScopesEnabled" Href="http://localhost:9399/api/security/accounts/de19303b-bcf3-428b-b113-ac0b2cf46bd7" />
 </Links>
 <AccountType>Group</AccountType>
 <AllowRestoreAllVms>false</AllowRestoreAllVms>
</EnterpriseAccount>