GET Administrators

Get App Orchestration administrators.

Request Information

Parameters

NameDescriptionAdditional information
name

See Filtering, Arranging, and Paging.

Type: String

filterBy

See Filtering, Arranging, and Paging. The supported filters are:

  • All: All administrators. (default)

Type: Filter

filterProp

See Filtering, Arranging, and Paging.

Type: String

arrangeBy

See Filtering, Arranging, and Paging. The supported arrangers are:

  • Name: Arrange by name. (default)

Type: String

skip

See Filtering, Arranging, and Paging.

Type: Number

take

See Filtering, Arranging, and Paging.

Type: Number

Response Information

A list of administrators.

Response type

CollectionResultModel<AdministratorModel>

Response body formats

application/json, text/json

Sample:
{
  "Href": "[api:Administrators]",
  "Count": 1,
  "TotalMatchingFilter": 1,
  "Items": [
    {
      "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"
        }
      ]
    }
  ]
}