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

/security/roles

Represents a collection of security roles used in Veeam Backup Enterprise Manager.

Veeam Backup Enterprise Manager RESTful API exposes the following security roles:

  • Portal User
  • Portal Administrator
  • VM Restore Operator
  • File Restore Operator
  • Exchange Restore Operator
  • SQL Restore Operator

Resource URL

https://<Enterprise-Manager>:9398/api/security/roles

Related Resources

Methods

The following methods are supported for the /security/roles resource:

(GET) /security/roles

Resource Representation

The /security/roles resource has a resource representation of the following type:

<EntityReferences xmlns="http://www.veeam.com/ent/v1.0">
 <Ref Type="EnterpriseRoleReference" Href="https://localhost:9398/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="https://localhost:9398/api/security/roles/d19a3d33-cb77-4ffe-94e6-001432483a4e?format=Entity" />
   </Links>
 </Ref>
 <Ref Type="EnterpriseRoleReference" Href="https://localhost:9398/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="https://localhost:9398/api/security/roles/f78a92b8-9f06-4f1e-b522-4f0927cabd0f?format=Entity" />
   </Links>
 </Ref>
 <Ref Type="EnterpriseRoleReference" Href="https://localhost:9398/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="https://localhost:9398/api/security/roles/f84a8b62-49b8-4d0c-b25b-92321b52bab6?format=Entity" />
   </Links>
 </Ref>
 <Ref Type="EnterpriseRoleReference" Href="https://localhost:9398/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="https://localhost:9398/api/security/roles/f83e4c81-0815-452f-9377-9d573dd9d481?format=Entity" />
   </Links>
 </Ref>
 <Ref Type="EnterpriseRoleReference" Href="https://localhost:9398/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="https://localhost:9398/api/security/roles/5f37a46b-9ce2-40f4-8a62-b45b079257fc?format=Entity" />
   </Links>
 </Ref>
 <Ref Type="EnterpriseRoleReference" Href="https://localhost:9398/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="https://localhost:9398/api/security/roles/c11c0c38-ba8b-49c7-bf70-fc2058fff1e2?format=Entity" />
   </Links>
 </Ref>
</EntityReferences>