POST /security/accounts/{ID}/roles
Assigns a Veeam Backup Enterprise Manager security role to the specified account.For details on security roles, see Security Roles.
Request
To assign a security role to an account having the specified ID, send the POST HTTP request to the URL of the /security/accounts/{ID}/roles resource.
HTTP Request
POST https://<Enterprise-Manager>:9398/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. For details, see Authentication and Security. |
Content-Type | True | Identifies the format of the request body message. Possible values:
|
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
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 REST API.
Important |
If you use the XML media type, make sure that the order of parameters in the request body is correct. For details, see request body examples in this section. |
The request body must contain the following elements:
Element | Type | Description | Modifiable | Min/Max Occurrence |
|---|---|---|---|---|
EnterpriseRoleUid | UidType | UID 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 Representation
<?xml version="1.0" encoding="utf-8"?> |
JSON Representation
{ "EnterpriseRoleUid": "urn:veeam:EnterpriseRole:c11c0c38-ba8b-49c7-bf70-fc2058fff1e2" } |
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. Possible values:
|
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 https://localhost:9398/api/security/accounts/f7d81d38-a457-4ee7-9294-a9123f8e4e99/roles
Request Headers: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Request Body: <?xml version="1.0" encoding="utf-8"?>
Response: 201 Created
Response Body: None |