Getting Information About AD Security Groups Using A GraphQL Request

You can get information about AD security groups using a GraphQL query in GraphiQL.

A query for AD security groups can be executed only from the API Key with the assigned "Users" privilege with the access operation R (reading). You can find more information about API Key creation and how to assign a privilege to a created key in the following sections:

• Access Rights For API Keys

Configure the AD integration using the following query:

mutation {
  app_config {
    active_directory {
      update_config(sync_employee_group_membership_enabled:true) {
        sync_employee_group_member_enabled
      }
    }
  }
}

Query options for security groups:

1. Query without a filter:
   {
     active_directory {
       ad_group {
         employee_ad_groups {
           employee_id
           canonical_names
           distinguished_names
           names
         }
       }
     }
   } 
   

2. Query with a filter by users:
   {
     active_directory {
       ad_group {
         employee_ad_groups(ids:[<id_пользователя_1>, <id_пользователя_2>]) { 
           employee_id
           canonical_names
           distinguished_names
           names
         }
       }
     }
   }
   

Response example:

{
  "data": {
    "active_directory": {
      "ad_group": {
        "employee_ad_groups": [
          {
            "employee_id": 11,
            "canonical_names": [
              "dmitry.local/root/users/Users"
            ],
            "distinguished_names": [
              "CN=Users,OU=users,OU=root,DC=dmitry,DC=local"
            ],
            "names": [
              "Users"
            ]
          }
        ]
      }
    }
  }
} 

Also, a query can be executed through the automation block "HTTP request". Detailed information about the operation of the block is displayed in the Working With Services section.