# Deep Security Manager REST API

## Path: / rest / administrator-roles / {roleID}

Describe an administrator role.

Path parameters:
  roleID - the role ID.

Resources
Name | Description
--- | ---
host-groups | Update an administrator role with an additional set of host groups.
hosts | Update an administrator role with an additional set of hosts.
policies | Update an administrator role with an additional set of policies.
rights | Update an administrator role with an additional set of rights.

Method Summary
Resource | Description
--- | ---
`GET /rest/administrator-roles/{roleID}` | Describe an administrator role.
`POST /rest/administrator-roles/{roleID}` | Modify an administrator role.
`DELETE /rest/administrator-roles/{roleID}` | Delete an administrator role.

Method Detail
Describe an administrator role. Output: `DescribeAdministratorRoleResponse` - a {@link DescribeAdministratorRoleResponse} with the details of the administrator role. Cookie parameters: sID - a session ID returned by the Authentication API. Produces: application/json Consumes: application/json HTTP return codes: 200 - if the request is successful 403 - if the user is not authorized to view administrator roles 404 - if the user is authorized to view administrator roles but the administrator role does not exist or if the user is not authorized to view the requested administrator role
Modify an administrator role. Any unset elements in the request object will be left unchanged by the modify request. Input: `ModifyAdministratorRoleRequest` - a {@link ModifyAdministratorRoleRequest} with the details of the administrator role. Output: `ModifyAdministratorRoleResponse` - a {@link ModifyAdministratorRoleResponse} with the modified details of the administrator role. Cookie parameters: sID - a session ID returned by the Authentication API. Produces: application/json Consumes: application/json HTTP return codes: 200 - if the request is successful 403 - if the user is not authorized to modify administrator roles 404 - if the user is authorized to modify administrator roles but the administrator role does not exist or if the user is not authorized to modify the requested administrator role
Delete an administrator role. Output: `void` Cookie parameters: sID - a session ID returned by the Authentication API. Produces: application/json Consumes: application/json HTTP return codes: 200 - if the request is successful 403 - if the user is not authorized to delete administrator roles 404 - if the user is authorized to delete administrator roles but the administrator role does not exist or if the user is not authorized to delete the requested administrator role

Copyright © 2017 Trend Micro Inc. All Rights Reserved.