This is an archive version of the document. To get the most up-to-date information, see the
current version.
(GET) /security/roles
Returns a collection of security roles used in Veeam Backup Enterprise Manager.
To get a list of security roles used in Veeam Backup Enterprise Manager, you need to send the GET HTTP request to the URL of the /security/roles resource.
HTTP Request
GET http://<Enterprise-Manager>:9399/api/security/roles |
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.
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/roles resource collection.
The example below returns a list of security roles used in Veeam Backup Enterprise Manager.
Request: GET http://localhost:9399/api/security/roles Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj Response: 200 Success Response Body: <EntityReferences xmlns="http://www.veeam.com/ent/v1.0">
<Ref Type="EnterpriseRoleReference" Href="http://localhost:9399/api/security/roles/d19a3d33-cb77-4ffe-94e6-001432483a4e" Name="Portal User" UID="urn:veeam:EnterpriseRole:d19a3d33-cb77-4ffe-94e6-001432483a4e">
<Links>
<Link Rel="Alternate" Type="EnterpriseRole" Href="http://localhost:9399/api/security/roles/d19a3d33-cb77-4ffe-94e6-001432483a4e?format=Entity" />
</Links>
</Ref>
<Ref Type="EnterpriseRoleReference" Href="http://localhost:9399/api/security/roles/f78a92b8-9f06-4f1e-b522-4f0927cabd0f" Name="SQL Restore Operator" UID="urn:veeam:EnterpriseRole:f78a92b8-9f06-4f1e-b522-4f0927cabd0f">
<Links>
<Link Rel="Alternate" Type="EnterpriseRole" Href="http://localhost:9399/api/security/roles/f78a92b8-9f06-4f1e-b522-4f0927cabd0f?format=Entity" />
</Links>
</Ref>
<Ref Type="EnterpriseRoleReference" Href="http://localhost:9399/api/security/roles/f84a8b62-49b8-4d0c-b25b-92321b52bab6" Name="File Restore Operator" UID="urn:veeam:EnterpriseRole:f84a8b62-49b8-4d0c-b25b-92321b52bab6">
<Links>
<Link Rel="Alternate" Type="EnterpriseRole" Href="http://localhost:9399/api/security/roles/f84a8b62-49b8-4d0c-b25b-92321b52bab6?format=Entity" />
</Links>
</Ref>
<Ref Type="EnterpriseRoleReference" Href="http://localhost:9399/api/security/roles/f83e4c81-0815-452f-9377-9d573dd9d481" Name="Exchange Restore operator" UID="urn:veeam:EnterpriseRole:f83e4c81-0815-452f-9377-9d573dd9d481">
<Links>
<Link Rel="Alternate" Type="EnterpriseRole" Href="http://localhost:9399/api/security/roles/f83e4c81-0815-452f-9377-9d573dd9d481?format=Entity" />
</Links>
</Ref>
<Ref Type="EnterpriseRoleReference" Href="http://localhost:9399/api/security/roles/5f37a46b-9ce2-40f4-8a62-b45b079257fc" Name="Portal Administrator" UID="urn:veeam:EnterpriseRole:5f37a46b-9ce2-40f4-8a62-b45b079257fc">
<Links>
<Link Rel="Alternate" Type="EnterpriseRole" Href="http://localhost:9399/api/security/roles/5f37a46b-9ce2-40f4-8a62-b45b079257fc?format=Entity" />
</Links>
</Ref>
<Ref Type="EnterpriseRoleReference" Href="http://localhost:9399/api/security/roles/c11c0c38-ba8b-49c7-bf70-fc2058fff1e2" Name="VM Restore Operator" UID="urn:veeam:EnterpriseRole:c11c0c38-ba8b-49c7-bf70-fc2058fff1e2">
<Links>
<Link Rel="Alternate" Type="EnterpriseRole" Href="http://localhost:9399/api/security/roles/c11c0c38-ba8b-49c7-bf70-fc2058fff1e2?format=Entity" />
</Links>
</Ref>
</EntityReferences> |
