# Deep Security Manager REST API

## Name: AdministratorRole

Transport object for administrator role details.

JSON Example:
    {"AdministratorRole":
     {
       "allHosts": Boolean,
       "allowGUI": Boolean,
       "allowWebService": Boolean,
       "allPolicies": Boolean,
       "delegate": Boolean,
       "description": String,
       "hostGroups": [Number],
       "hosts": [Number],
       "name": String,
       "policies": [Number],
       "readOnly": Boolean,
       "rights": [String],
       "roleID": Number,
       "uRN": String,
     }
    }

Elements
Name | Type | Required | Default Value | Description
--- | --- | --- | --- | ---
allHosts | Boolean | No | `false` | Get the value of the "all hosts" flag. When the "all hosts" flag is `true`, rights assigned to the role will apply to all hosts.
allowGUI | Boolean | No | `false` | Get the value of the "allow GUI access" flag. When the "allow GUI access" flag is `true`, administrators with this role will be allowed to access the Deep Security Manager console.
allowWebService | Boolean | No | `false` | Get the value of the "allow Web Service access" flag. When the "allow Web Service access" flag is `true`, administrators with this role will be allowed to access the Deep Security Manager Web Services (SOAP) API.
allPolicies | Boolean | No | `false` | Get the value of the "all policies" flag. When the "all policies" flag is `true`, rights assigned to the role will apply to all policies.
delegate | Boolean | No | `false` | Get the value of the "delegate" flag. When the "delegate" flag is `true`, administrators with this role will have limited access to view and / or modify other administrator roles. The only roles that they will be able to view / modify are roles with equal or lesser access than their own.
description | String | No | `` | Get the role's description.
hostGroups | zero or N[Number] | No | `` | Get the list of host groups (IDs) associated with the role. You can limit the scope of permissions for rights that apply to hosts using this attribute in combination with the `hosts` attribute and the `allHosts` flag. If the `allHosts` flag is set to `true`, rights that are assigned to the role will apply to all hosts. When the `allHosts` flag is set to `false`, rights that are assigned to the role will apply only to hosts and host groups set using the `hosts` and `hostGroups` attributes.
hosts | zero or N[Number] | No | `` | Get the list of hosts (IDs) associated with the role. You can limit the scope of permissions for rights that apply to hosts using this attribute in combination with the `hostGroups` attribute and the `allHosts` flag. If the `allHosts` flag is set to `true`, rights that are assigned to the role will apply to all hosts. When the `allHosts` flag is set to `false`, rights that are assigned to the role will apply only to hosts and host groups set using the `hosts` and `hostGroups` attributes.
name | String | Yes | `` | Get the role's name.
policies | zero or N[Number] | No | `` | Get the list of policies (IDs) associated with the role. You can limit the scope of permissions for rights that apply to policies using this attribute in combination with the `allPolicies` flag. If the `allPolicies` flag is set to `true`, rights that are assigned to the role will apply to all policies. When the `allPolicies` flag is set to `false`, rights that are assigned to the role will apply only to policies set using the `policies` attribute.
readOnly | Boolean | No | `false` | Get the value of the "read-only" flag. The Deep Security Manager comes with a default "Full Access" role that is read-only and cannot be deleted or changed. It is not possible to create other read-only roles.
rights | zero or N[String] | No | `` | Get the list of rights assigned to the role.
roleID | Number | No | `` | Get the administrator role ID.
uRN | String | No | `` | Get the administrator role URN.

Copyright © 2017 Trend Micro Inc. All Rights Reserved.