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

(POST) /security/accounts/{ID}/roles

In this article

    Assigns a Veeam Backup Enterprise Manager security role to the specified user account.

    Request

    To assign a security role to an account having the specified ID, you need to send the POST HTTP request to the URL of the /security/accounts/{ID}/roles resource.

    HTTP Request

    POST http://<Enterprise-Manager>:9399/api/security/accounts/{ID}/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

    In the request body, the client must send the parameters for the role that should be assigned to the account. The body of the request must conform to the XML Schema Definition of Enterprise Manager RESTful API.

    The request body must contain the following elements:

    Element

    Type

    Description

    Modifiable

    Min/Max Occurrence

    EnterpriseRoleUid

    URN

    ID of the role that must be assigned to the account. To get a list of IDs for available roles, send the GET HTTP request to the /security/roles resource.  

    No

    1/1

    For example:

    <?xml version="1.0" encoding="utf-8"?>
    <EnterpriseAccountInRoleCreateSpec xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <EnterpriseRoleUid>urn:veeam:EnterpriseRole:c11c0c38-ba8b-49c7-bf70-fc2058fff1e2</EnterpriseRoleUid>
    </EnterpriseAccountInRoleCreateSpec>

    Query Parameters

    None.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns response code 201 Created.

    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

    None.

    Example

    The example below assigns the VM Restore Operator role to the account having ID f7d81d38-a457-4ee7-9294-a9123f8e4e99:

    Request:

    POST http://localhost:9399/api/security/accounts/f7d81d38-a457-4ee7-9294-a9123f8e4e99/roles

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Request Body:

    <?xml version="1.0" encoding="utf-8"?>
    <EnterpriseAccountInRoleCreateSpec xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <EnterpriseRoleUid>urn:veeam:EnterpriseRole:c11c0c38-ba8b-49c7-bf70-fc2058fff1e2</EnterpriseRoleUid>
    </EnterpriseAccountInRoleCreateSpec>

     

    Response:

    201 Created

     

    Response Body:

    None