GET /security/accounts/{ID}/roles/{ID}

Returns a specific security role assigned to the specified account that is added to Veeam Backup Enterprise Manager. For details on security roles, see Security Roles.

Request

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

HTTP Request

GET https://<Enterprise-Manager>:9398/api/security/accounts/{ID}/roles/{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.

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, the REST API returns the /security/accounts/{ID}/roles/{ID} resource that contains the following parameters and links.

Parameters

Element

Type

Description

RoleName

String

Name of the security role assigned to the account, for example: Portal User.

Links

Reference

Relationship

Description

/security/accounts/{ID}/roles/{ID}

Delete

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

Example

A sample request below returns the File Restore Operator role assigned to the account having ID f7d81d38-a457-4ee7-9294-a9123f8e4e99:

Request:

GET https://localhost:9398/api/security/accounts/f7d81d38-a457-4ee7-9294-a9123f8e4e99/roles/f84a8b62-49b8-4d0c-b25b-92321b52bab6

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 OK

 

Response Body:

<EnterpriseAccountInRole xmlns="http://www.veeam.com/ent/v1.0" Href="https://localhost:9398/api/security/accounts/f7d81d38-a457-4ee7-9294-a9123f8e4e99/roles/f84a8b62-49b8-4d0c-b25b-92321b52bab6">
 <Links>
   <Link Rel="Delete" Type="EnterpriseAccountInRole" Href="https://localhost:9398/api/security/accounts/f7d81d38-a457-4ee7-9294-a9123f8e4e99/roles/f84a8b62-49b8-4d0c-b25b-92321b52bab6" />
 </Links>
 <RoleName>File Restore Operator</RoleName>
</EnterpriseAccountInRole>