GET /security/accounts/{ID}

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, send the GET HTTP request to the URL of the /security/accounts/{ID} resource.

HTTP Request

GET https://<Enterprise-Manager>:9398/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. For details, see Authentication and Security.

Accept

False

Identifies the format of the response. Possible values:

  • application/xml — the client can send this value in the header to accept response in the XML format.
  • application/json — the client must send this value in the header to accept the request in the JSON format.

If the request does not contain the header, the server will return the response in the XML format.

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 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. Possible values:

  • application/xml
  • application/json

Response Body

In the response body, Veeam Backup Enterprise Manager returns an entity or an entity reference of the /security/accounts/{ID} resource. The resource entity contains the following parameters and links.

Parameters

Element

Type

Description

UID

UidType

UID of the account that has a specific security role in Veeam Backup Enterprise Manager, for example: urn:veeam:EnterpriseAccount:9570aed1-7eff-4684-b77a-7735bdbe820d.

Name

String

Name of the account that has a specific security role in Veeam Backup Enterprise Manager, for example: BACKUPSERVER\Operator.

AccountType

String

Type of the account that has a specific security role in Veeam Backup Enterprise Manager. Possible values:

  • User
  • Group
  • ExternalUser
  • ExternalGroup

Accounts of the ExternalUser and ExternalGroup type are created for users that will access Veeam Backup Enterprise Manager using a single sign-on service. For details, see the SAML Authentication Support section in the Veeam Backup Enterprise Manager Guide.

AllowRestoreAllVms

Boolean

Defines whether the account must have permissions to restore all VMs or not. Possible values:

  • True
  • False

FlrSettings

FileRestoreSettingsInfoType

File-level restore restrictions assigned to the added account. For details, see File-Level Restore Settings.

SqlSettings

SqlRestoreSettingsInfoType

SQL restore restrictions assigned to the added account. For details, see SQL restore settings.

File-Level Restore Settings

Element

Type

Description

FlrInplaceOnly

Boolean

Defines whether the account has permissions to restore only files with specific filename extensions or not.

FlrExtentionRestrictions

String

Filename extensions for files that are permitted for restore separated by comma, for example: doc,pptx,pdf.

 

SQL Restore Settings

Element

Type

Description

DenyInPlaceRestore

Boolean

Defines whether the account is prevented from overriding production databases at restore.

 

Links

Reference

Relationship

Description

/security/accounts/{ID}

Alternate

Alternate URL of the /security/roles/{ID} resource.

/security/accounts/{ID}/roles

Down

URL of the /security/accounts/{ID}/roles resource — a collection of security roles assigned to the account.

/security/accounts/{ID}/roles

Create

URL for the POST /security/accounts/{ID}/roles request.

/security/accounts/{ID}/scopes

Down

URL of the /security/accounts/{ID}/scopes resource — a collection of restore scopes defined for the account.

/security/accounts/{ID}/scopes

Create

URL for the POST /security/accounts/{ID}/scopes request.

/security/accounts/{ID}

Delete

URL for the DELETE /security/accounts/{ID} request.

/security/accounts/{ID}

ToggleRestoreScopesEnabled

URL for the POST /security/accounts/{ID} request.

Example

A sample request below returns an account having ID 605cff11-7437-42dc-bd1e-262222cfdddc:

Request:

GET https://localhost:9398/api/security/accounts/605cff11-7437-42dc-bd1e-262222cfdddc

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 OK

 

Response Body:

<?xml version="1.0" encoding="utf-8"?>
<EnterpriseAccount xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Href="https://enterprise04.tech.local:9398/api/security/accounts/d6701c3d-15f4-421d-b376-c0e2634bc1f4?format=Entity" Type="EnterpriseAccount" Name="TECH\william.fox" UID="urn:veeam:EnterpriseAccount:d6701c3d-15f4-421d-b376-c0e2634bc1f4" xmlns="http://www.veeam.com/ent/v1.0">
   <Links>
       <Link Href="https://enterprise04.tech.local:9398/api/security/accounts/d6701c3d-15f4-421d-b376-c0e2634bc1f4" Type="EnterpriseAccountReference" Rel="Alternate" />
       <Link Href="https://enterprise04.tech.local:9398/api/security/accounts/d6701c3d-15f4-421d-b376-c0e2634bc1f4/roles" Type="EnterpriseAccountInRoleList" Rel="Down" />
       <Link Href="https://enterprise04.tech.local:9398/api/security/accounts/d6701c3d-15f4-421d-b376-c0e2634bc1f4/roles" Type="EnterpriseAccountInRole" Rel="Create" />
       <Link Href="https://enterprise04.tech.local:9398/api/security/accounts/d6701c3d-15f4-421d-b376-c0e2634bc1f4/scopes" Type="EnterpriseAccountHierarchyScopeList" Rel="Down" />
       <Link Href="https://enterprise04.tech.local:9398/api/security/accounts/d6701c3d-15f4-421d-b376-c0e2634bc1f4/scopes" Type="EnterpriseAccountHierarchyScope" Rel="Create" />
       <Link Href="https://enterprise04.tech.local:9398/api/security/accounts/d6701c3d-15f4-421d-b376-c0e2634bc1f4" Rel="Delete" />
       <Link Href="https://enterprise04.tech.local:9398/api/security/accounts/d6701c3d-15f4-421d-b376-c0e2634bc1f4" Rel="ToggleRestoreScopesEnabled" />
   </Links>
   <AccountType>User</AccountType>
   <AllowRestoreAllVms>true</AllowRestoreAllVms>
   <FlrSettings>
       <FlrInplaceOnly>false</FlrInplaceOnly>
       <FlrExtentionRestrictions />
   </FlrSettings>
   <SqlSettings>
       <DenyInPlaceRestore>false</DenyInPlaceRestore>
   </SqlSettings>
</EnterpriseAccount>