Find Security Roles

{ getRolesByName }

Returns a role and its metadata using the search criteria.

Method

/API2/access/getRolesByName

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

    Name

    searchCriteria

    Object Type

    Description

    The search criteria for finding materialized data elements.

    Output Response

    Successful Result Code

    200

    Response List Type

    Description of Response Type

    Role response object with details of each role found in the system. Note that the response is returned as a list of items of this object type.

    Notes

    Use this function together with 'getRoleById' to select and use roles in the system.

    Examples
    User Operations (JavaScript):

    This example demonstrates how to find and delete users, roles and tenants.

    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 = "http://mysite.com/api2/";
    
    // step 1: authenticate admin account and get token
    // NOTE: callApi method is a generic REST method shown below.
    let token = callApi("auth/authenticateUser",{
    	"data":{
    		"userName":"adminUser1",
    		"password":"abc123!"
    	}
    },false);
    log("got token "+token);
    
    //########## user ################
    
    //step 2: searching for a user by it's name
    let findUser= callApi("access/getUsersByName",{
    	"userName": "john",
    	"auth": token // admin token generated above
    });
    				
    // get user ID				
    let userId=findUser.data[0].id;
    				
    log("found user with id= "+ userId);
    
    //step 3: deleting the role
    let deleteUser=callApi("access/deleteUser",{
    	"userId": userId, //from step 2
    	"auth": token // admin token generated above
    });
    
    
    //########## role ################
    
    //step 4: searching for a role by it's name
    let findRole= callApi("access/getRolesByName",{
    	"data": {
    		"searchValue": "test role",
    		"searchMatchType": 2// search flag enumerations. 2 = SearchMatchType.Equals
    	},
    	"auth": token // admin token generated above
    });
    // get role ID	
    let roleId=findRole.data[0].roleId;
    				
    log("found role with id= "+ roleId);
    
    //step 5: deleting the role
    let deleteRole=callApi("access/deleteRole",{
    	"roleId": roleId, // from step 4
    	"auth": token
    });
    
    
    //########## tenant ################
    
    //step 6: search for tenant
    let findTenenat=callApi("access/getTenantByName",{
    	"tenantName": "Test Tenant 1",
    	"auth": token
    });
    // get tenant ID					
    let tenantId=findTenenat.data.id;
    				
    log("found tenant by name "+ tenantId);
    
    //step 7: delete the tenant we found in step 2
    let deleteTenants=callApi("access/deleteTenants",{
    	"data": {
    	"tenantIds": [
    		tenantId
    	], // use the array method, because it can accept multiple ID's
    	"deleteUsers": true, //delete all tenant users
    	"deleteServers": true //delete all data source servers associated with tenant
    	},
    	"auth": token
    });
    
    
    
    // ##### optional generic logging method for debugging ##############
    function log(msg){
    	document.write(msg);
    	console.log(msg);
    }
    
    // ##### generic REST API calling method ##############
    function callApi(path,data,parseResult=true){
    	var xhttp = new XMLHttpRequest();
    	xhttp.open("POST", pyramidURL+path, false);
    	xhttp.send(JSON.stringify(data));
    	if(parseResult){
    		return JSON.parse(xhttp.responseText);
    	}else{
    		return xhttp.responseText;
    	}
    }
    
    
    		
    Content Operations (JavaScript):

    This example demonstrates how to manage content items in Pyramid.

    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 = "http://mySite.com/api2/";
    
    // step 1: authenticate admin account and get token
    // NOTE: callApi method is a generic REST method shown below.
    let token = callApi("auth/authenticateUser",{
    	"data":{
    		"userName":"adminUser",
    		"password":"abc123!"
    	}
    },false);
    log("got token "+token);
    
    //step 2: get the default tenant ID
    let defaultTenant=callApi("access/getDefaultTenant",{
    	"auth": token // admin token generated above
    }).data;
    
    //step 3: return the ID of the public root folder for the tenant from step 2
    let tenentPublicFolder = callApi("content/getPublicOrGroupFolderByTenantId",{
    	"folderTenantObject": {
    		"validRootFolderType": 1,//the public folder of the default tenant
    		"tenantId": defaultTenant
    	},
    	"auth": token //admin token generated from step 1 above
    }).data;
    
    //step 4: add a new folder to the public folder from step 3
    let folderCreation = callApi("content/createNewFolder",{
    	"folderTenantObject": {
    		"parentFolderId": tenentPublicFolder.id,
    		"folderName": "new folder"
    	},
    	"auth": token
    }).data;
    let folderId=folderCreation.modifiedList[0].id;
    
    //step 5: find roles
    let findRole = callApi("access/getRolesByName",{
    	"data": {
    		"searchValue": "role1",
    		"searchMatchType": 2//SearchMatchType.Equals
    	},
    	"auth": token
    });
    let roleId=findRole.data[0].roleId;
    log("found role with id= "+ roleId);
    
    //step 6:add the role we found in step 5 to the folder we created (folderId) in step 4
    let addRoleToFolder= callApi("content/addRoleToItem",{
    	"roleToItemApiData": {
    		"itemId": folderId,
    		"roleId": roleId//SearchMatchType.Equals
    	},
    	"auth": token
    });
    
    //step 7: read in a Pyramid Import/Export ('PIE') file
    let file="http://myOtherSite.com/Sample.pie";
    let pieFile=readPieFile(file);
    
    //step 8: import the PIT file into the folder from step 4
    let importContent = callApi("content/importContent",{
    	"pieApiObject": {
    		"rootFolderId": folderId, //from step 4
    		"fileZippedData": pieFile, //the file's content from step 7
    		"clashDefaultOption":1,//ClashDefaultOption.REPLACE_FILE like default
    		"rolesAssignmentType":3//RoleAssignmentType.ForceParentFolderRoles take roles from parent folder
    	},
    	"auth": token
    }).data;
    let itemId=Object.keys(importContent.importDscMap)[0];
    
    //step 9: optional, search for the item we just imported, it's id is itemId
    let findContentItem = callApi("content/findContentItem",{
    	"searchParams":{
    		"searchString":"import",
    		"filterTypes":[3],//ContentTypeObject.DataDiscoveryv
    		"searchMatchType":2,//SearchMatchType.Equals
    		"searchRootFolderType":1//SearchRootFolderType.Public
    		
    	},
    	"auth": token
    }).data;
    
    
    //step 10: check if you need to run datasource changer 
    // (since the datasource that created this report dosen't exisits on this server)
    if(importContent.importDscMap[itemId][0].needsToPerformDsc){
    
    	step 10A: get item's data source connection
    	let correntConnectionStringId=importContent.importDscMap[itemId][0].connectionStringProperties.id
    	
    	//step 10B: run the data source changer on the items
    	let changedDatasource = callApi("dataSources/changeDataSource",{
    		"dscApiData":{
    			"fromConnId":correntConnectionStringId,
    			"toConnId":"55ff277a-53ff-4c39-8f15-5651f1026a2d",//retrive this id using 'getAllConnectionStrings'
    			"itemId":itemId
    		},
    		"auth": token
    	});
    }
    
    //step 11: copying the imported item to the tenant root folder
    let copyItems = callApi("content/copyItems",{
    	"moveItemsObject":{
    		"itemsForMove":[itemId],
    		"destinationFolder":tenentPublicFolder.id		
    	},
    	"auth": token
    }).data;
    
    //step 12: remove roles from the folder but not from the item
    let removeRoleFromCreatedFolder= callApi("content/removeRolesFromItem",{
    	"rolesInItemRemovalObject": {
    		"itemId": folderId,
    		"roleIds": [roleId]
    	},
    	"auth": token
    });
    
    //step 13: hard delete the folder (permanently)
    let folderDeletion = callApi("content/purgeContentItems",{
    	"itemIds":[folderCreation.modifiedList[0].id],
    	"auth": token
    });
    
    //step 14: soft-delete the items
    let itemSoftDeletion = callApi("content/softDeleteContentItems",{
    	"itemIds":[copyItems.modifiedList[0].id],
    	"auth": token
    });
    
    
    
    
    function log(msg){
    	document.write(msg);
    	console.log(msg);
    }
    
    function callApi(path,data,parseResult=true){
    	var xhttp = new XMLHttpRequest();
    	xhttp.open("POST", pyramidURL+path, false);
    	xhttp.send(JSON.stringify(data));
    	if(parseResult){
    		return JSON.parse(xhttp.responseText);
    	}else{
    		return xhttp.responseText;
    	}
    }
    
    //example function to read in the contents of a 'PIE' file that contains
    //exported Pyramid content.
    function readPieFile(file){
    	var rawFile = new XMLHttpRequest();
    	rawFile.open("GET", file, false);
    	rawFile.send(null);
    	rawFile.onreadystatechange = function () {
    		if (request.readyState === 4 && request.status === 200) {
    			return request.responseText;
            }
        }
    }