CollectionResultModel<AdministratorModel>

A collection of items.

Properties

NameDescription Additional information
Href

See Hypermedia.

Type: String

RelatedActions

See Hypermedia.

Type: Array of RelationModel

Count

Number of items in the returned collection. See Object Counts.

Type: Number

TotalMatchingFilter

The total number of items that matched the specified filter. This may be larger than the number of items returned, if the caller specified "take" and/or "skip" parameters. See Object Counts.

Type: Number

Items

The items.

Type: Array of AdministratorModel

Sample

application/json

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