UpdateAdministratorModel

New details to update an existing administrator.

Properties

NameDescription Additional information
Category

If specified, category to change the administrator to.

Type: AdministratorCategory

RoleId

If specified, ID of the role to change the administrator to. 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 specified, change whether the administrator is restricted to performing operations within one or more scopes. If this is changed from false to true, you must also specify "RoleScopesIds".

Type: Boolean

RoleScopesIds

If specified, update the list 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:
{
  "Category": "SingleRole",
  "RoleId": "FCE10C6A-4518-4949-A88A-6081B57E0EA9",
  "IsRoleScoped": true,
  "RoleScopesIds": [
    "5e531466-5c6d-41c8-97e1-d814d261f322"
  ],
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ]
}