CreateAdministratorModel

Details of an administrator to create.

Properties

NameDescription 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:

  • FCE10C6A-4518-4949-A88A-6081B57E0EA9: Read-only
  • 386D6CEE-4120-4018-8BB1-350CA9D1789F: Help desk
  • CEE2AA44-1B5E-461E-BDE1-548D1E76B1A0: Self service

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

See Tags and Custom Properties.

Type: Array of String

CustomProperties

See Tags and Custom Properties.

Type: Array of CustomPropertyModel

Sample

application/json

Sample:
{
  "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"
    }
  ]
}