AdministratorModel

Representation of an App Orchestration administrator.

Properties

Name	Description	Additional information
Href	See Hypermedia.	Type: String
RelatedActions	See Hypermedia.	Type: Array of RelationModel
Id	ID of the administrator.	Type: String
Name	Name of the administrator, in SAM format (DOMAIN\name).	Type: String
ChangeId	See Optimistic Concurrency.	Type: String
IsUserGroup	If true, this administrator refers to an Active Directory user group. If false, this administrator refers to a single Active Directory user.	Type: Boolean
Category	Administrator category.	Type: AdministratorCategory
RoleId	Administrator role ID. The built-in role IDs are: FCE10C6A-4518-4949-A88A-6081B57E0EA9: Read-only 386D6CEE-4120-4018-8BB1-350CA9D1789F: Help desk CEE2AA44-1B5E-461E-BDE1-548D1E76B1A0: Self service	Type: String
RoleName	Administrator role name.	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.	Type: Boolean
RoleScopes	The list of scopes which the administrator has permission within. This is only used if "IsRoleScoped" is true.	Type: Array of AuthorizationScopeModel
Tags	See Tags and Custom Properties.	Type: Array of String
CustomProperties	See Tags and Custom Properties.	Type: Array of CustomPropertyModel

Sample

application/json

Sample:

{
  "Href": "[api:Administrators(c52689f8-7ae8-4f99-ab33-08a4814e6ab9)]",
  "RelatedActions": [
    {
      "Name": "UpdateAdministrator",
      "References": [
        {
          "Href": "[api:Administrators(5e531466-5c6d-41c8-97e1-d814d261f323)]",
          "Name": "DOMAIN\\ReadOnlyAdmins",
          "Id": "5e531466-5c6d-41c8-97e1-d814d261f323"
        }
      ]
    }
  ],
  "Id": "c52689f8-7ae8-4f99-ab33-08a4814e6ab9",
  "Name": "DOMAIN\\ReadOnlyAdmins",
  "ChangeId": "4",
  "IsUserGroup": true,
  "Category": "SingleRole",
  "RoleId": "FCE10C6A-4518-4949-A88A-6081B57E0EA9",
  "RoleName": "ReadOnly",
  "IsRoleScoped": true,
  "RoleScopes": [
    {
      "Id": "5e531466-5c6d-41c8-97e1-d814d261f322",
      "Category": "Tenant",
      "Name": "Tenant 1"
    }
  ],
  "Tags": [
    "tag"
  ],
  "CustomProperties": [
    {
      "Name": "myProperty",
      "Value": "myValue"
    }
  ]
}