CreateAdministratorModel
Details of an administrator to create.
Properties
Name | Description | Additional information |
---|---|---|
Name | Name of the new administator. This must be unique, and must be in SAM format (DOMAIN\user). This may be either an Active Directory user or user group. Required. |
Type: String |
Category | Category of administrator to create. |
Type: AdministratorCategory |
RoleId | Administrator role ID. The valid values are:
|
Type: String |
IsRoleScoped | If true, this administrator is restricted to performing operations within one or more scopes. If false, this administrator's permissions are allowed in all scopes. If you set this to true, you must also set "RoleScopesIds". |
Type: Boolean |
RoleScopesIds | List of one or more IDs of scopes in which the administrator will have permissions. Only used if "IsRoleScoped" is true. |
Type: Array of String |
Tags |
Type: Array of String |
|
CustomProperties |
Type: Array of CustomPropertyModel |
Sample
application/json
{ "Name": "DOMAIN\\joe", "Category": "SingleRole", "RoleId": "FCE10C6A-4518-4949-A88A-6081B57E0EA9", "IsRoleScoped": true, "RoleScopesIds": [ "5e531466-5c6d-41c8-97e1-d814d261f322" ], "Tags": [ "tag" ], "CustomProperties": [ { "Name": "myProperty", "Value": "myValue" } ] }