The DSGroups table contains the groups from all directory services used by the tenant. Note that not all directory services (Cloud User Service, for example) define groups.

ColumnTypeDescription
InternalNameStringGroup's name internal to the directory service (if any) (primary key).
SystemNameStringGroup's system name (login name).
DisplayNameStringGroup's display name.
DescriptionStringDescriptive text for the group.
ServiceInstanceStringName of the directory service to which the group belongs.
ServiceInstanceLocalizedStringLocalized name of the directory service to which the group belongs.
ServiceTypeLocalized StringType of the directory service the Group is from (Active directory, LDAP, etc.).
DirectoryServiceUuidStringUUID of the directory service to which the group belongs.
ForestStringActive Directory forest of the Group (present for Active Directory Groups only).

Example Query

The query searches the DSGroups table for users with "test" in their name.

{
Script: "Select * from DSGroups 
    WHERE SystemName LIKE '%test%' 
    ORDER BY InternalName COLLATE NOCASE"
}

The query returns all users with "test" in their internal name.

DSGroups table query response:

...
"FullCount": 3,
"Results": [
  {
    "Entities": [
      {
        "Type": "DsGroups",
         "Key": "********-****-****-****-************",
         "IsForeignKey": false
      }
    ],
    "Row": {
      "ServiceType": "AdProxy",
      "DisplayName": "EngSmokeTest",
      "ServiceInstance": "AdProxy_idaptive.com",
      "ServiceInstanceLocalized": "Active Directory (idaptive.com)",
      "SystemName": "[email protected]",
      "Description": null,
      "InternalName": "********-****-****-****-************",
      "_MatchFilter": null,
      "Forest": "idaptive.com",
      "DirectoryServiceUuid": "********-****-****-****-************"
    }
  },
  {
    "Entities": [
      {
        "Type": "DsGroups",
        "Key": "********-****-****-****-************",
        "IsForeignKey": false
      }
    ],
     "Row": {
      "ServiceType": "AdProxy",
      "DisplayName": "testDL",
      "ServiceInstance": "AdProxy_idaptive.com",
      "ServiceInstanceLocalized": "Active Directory (idaptive.com)",
      "SystemName": "[email protected]",
      "Description": null,
      "InternalName": "********-****-****-****-************",
      "_MatchFilter": null,
      "Forest": "idaptive.com",
      "DirectoryServiceUuid": "********-****-****-****-************"
    }
   },
  {
    "Entities": [
      {
        "Type": "DsGroups",
        "Key": "********-****-****-****-************",
        "IsForeignKey": false
      }
    ],
    "Row": {
      "ServiceType": "AdProxy",
       "DisplayName": "cloudsupporttest",
      "ServiceInstance": "AdProxy_idaptive.com",
      "ServiceInstanceLocalized": "Active Directory (idaptive.com)",
      "SystemName": "[email protected]",
      "Description": null,
       "InternalName": "********-****-****-****-************",
       "_MatchFilter": null,
      "Forest": "idaptive.com",
      "DirectoryServiceUuid": "********-****-****-****-************"
    }
  }