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.

Column

Type

Description

InternalName

String

Group's name internal to the directory service (if any) (primary key).

SystemName

String

Group's system name (login name).

DisplayName

String

Group's display name.

Description

String

Descriptive text for the group.

ServiceInstance

String

Name of the directory service to which the group belongs.

ServiceInstanceLocalized

String

Localized name of the directory service to which the group belongs.

ServiceType

Localized String

Type of the directory service the Group is from (Active directory, LDAP, etc.).

DirectoryServiceUuid

String

UUID of the directory service to which the group belongs.

Forest

String

Active 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": "Eng[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": "********-****-****-****-************"
    }
  }