Get Active Directory Groups for a Role

{ getGroupsByRole }

Returns AD security groups used in a role



  • API Section: /API2/access
  • API Version: 2.0
  • From Release: 2018.5
  • Method operates via POST actions only.
  • Input Parameters






    The system role ID

    Output Response

    Successful Result Code


    Response List Type

    Description of Response Type

    LDAP Group object with details of the groups found in the role. Note that the response is returned as a list of items of this object type.


    Only applies if the Active Directory is used as the authentication provider

    Create new Active Directory user (JavaScript):

    This example demonstrates how to find and add a new user and roles in Pyramid, when using Active Directory authentication.

    The example uses API authentication driven from JavaScript. See Authentication APIs for alternatives.

    // URL of the Pyramid installation and the path to the API 2.0 REST methods
    var pyramidURL = "";
    // step 1: authenticate admin account and get token. 
    //This assumes authentication with Windows Authentication SSO. Therefore the account logging on is an admin account.
    // NOTE: callApi method is a generic REST method shown below. And inside it, xhttp.withCredentials = true;
    let token = callApi("auth/authenticateUserWindows",{},false); 
    log("got token "+token);
    //step 2: Get the defult tenant.
    let defaultTenantResult = callApi("access/getDefaultTenant",{
    	"auth": token // admin token generated above
    let tenantId =;
    log("default tenant, id= "+tenantId);
    //step 3: search for an active directory user in the AD itself
    let searchUsers=callApi("access/searchAdUsers",{
    		"ldapSearchType": 0, //search type enumeriation. 0 = exact
    	"auth": token // admin token generated above
    let adUser =[0];
    log("adUser = "+adUser.firstName);
    //step 4: creating a user using the results from the search in step 3
    let createUser = callApi("access/createAdUser",{
    	"newLdapUser": {
    	"userName": adUser.userName, //using the search result from step 3 above
    	"adminType": 0, //admin type
    	"clientLicenseType": 100,//ClientLicenseType.Viewer
    	"statusID": 1,
    	"tenantId": tenantId, //tenant Id from above
    	"auth": token // admin token generated above
    let userId =[0].id;
    log("created user "+userId);
    //step 5: optional, changing the user from Viewer to Professional
    let updateUser=callApi("access/updateAdUsers",{
    		"userName": adUser.userName,
    		"clientLicenseType": 200,//ClientLicenseType.Professional
    	"auth": token
    //step 6: creating 2 roles
    let createRole=callApi("access/createRoles",{
    	"data": [{
    		"roleName": "role1",
    		"tenantId": tenantId,
    		"isGroupRole": false
    		"roleName": "role2",
    		"tenantId": tenantId,
    		"isGroupRole": false
    	"auth": token
    let role1 =[0].id;
    let role2 =[1].id;
    log("created roles "+role1+","+role2);
    //step 7: binding user to role1 from step 6
    let addUserToRole=callApi("access/addUserToRole",{
    	"addUserRoleData": {
    	"auth": token
    //step 8: searchAdGroupsForUser, searching for AD groups of the given user in the given domain
    let groups=callApi("access/searchAdGroupsForUser",{
    	"searchData": {
    	"auth": token
    log("groups of " + adUser.userName" + "+JSON.stringify(;
    //step 9: add role2 to the AD security group from step 8
    let addRoleToAdGroup=callApi("access/changeRoleAdGroupMembership",{
    	"roleAdGroups": {
    	"auth": token
    log("addRoleToAdGroup "+JSON.stringify(addRoleToAdGroup));
    //step 10: optional get all groups by role - this will find the selected Group from step 9
    let groupsFound=callApi("access/getGroupsByRole",{
    	"auth": token
    log("found group "[0].name);
    // ##### optional generic logging method for debugging ##############
    function log(msg){
    // ##### generic REST API calling method ##############
    function callApi(path,data,parseResult=true){
    	var xhttp = new XMLHttpRequest();
    	//notice we changed callApi and added xhttp.withCredentials = true; to pass the windows credentials
    	xhttp.withCredentials = true;
 "POST", pyramidURL+path, false);
    		return JSON.parse(xhttp.responseText);
    		return xhttp.responseText;