Retrieve the List of Security Roles Assigned for a Logged-In Dynamics 365 User

This blog provides a JavaScript function to retrieve the list of security roles assigned for a logged-in user.

Introduction

 

In this blog, I will demonstrate how to get the Dynamics CRM User’s security role using JavaScript.

 

Retrieving the current user logged in to Dynamics 365

 

The function 'RetrieveLoggedInD365UserSecurityRoles()' gets the current global context that contains the user settings. There is a property in user settings for retrieving security roles GUIDs (userSettings.securityRoles) and the GUIDs are stored in an array 'loggedInUserSecurityRolesArray'. With those GUIDs, we can query Role entity to get the security role names using FetchXML. We are using FetchXML_GetRecords(originalFetch, entityname) function to retrieve the security role names from Role entity.

 

JavaScript

//***********To get the LoggedIn D365 User’s Security Role**************//

function RetrieveLoggedInD365UserSecurityRoles() {
var resultset = "";
var fetchXMLCondition = "";
// Get Logged In D365 User’s Context
var userSettings = Xrm.Utility.getGlobalContext().userSettings;
// Get Logged In User Security Roles GUIDs
var loggedInUserSecurityRolesArray = userSettings.securityRoles;
var totalSecurityRolesArray = new Array();
var rolesOutputText = "";
if (loggedInUsersecurityRolesArray.length > 0) {
var i;
// Framing the conditions for FetchXML to get Security Role names using the Security Roles GUIDs
for (i = 0; i < loggedInUsersecurityRolesArray.length; i++) {
fetchXMLCondition += "<condition attribute='roleid' operator='eq' value='" + loggedInUsersecurityRolesArray[i] + "'/>";
}
var fetchXML = "<fetch version='1.0' output-format='xml-platform' mapping='logical' distinct='false'>" +
"<entity name='role'>" +
"<attribute name='roleid' />" +
"<attribute name='name' />" +
"<order attribute='name' descending='false' />" +
"<filter type='or'>" + fetchXMLCondition +
"</filter>" +
"</entity>" +
"</fetch>";
resultset = FetchXML_GetRecords(fetchXML, "roles");
}
// returns the resultset that has the security roles assigned for the current logged in user
return resultset;
}

//***************FetchXML to get the result set***********************//
function FetchXML_GetRecords(originalFetch, entityname) {
var records;
var fetch = encodeURI(originalFetch);
var serverURL = Xrm.Page.context.getClientUrl();
var Query = entityname + "?fetchXml=" + fetch;
var req = new XMLHttpRequest();
req.open("GET", serverURL + "/api/data/v9.0/" + Query, false);
req.setRequestHeader("OData-MaxVersion", "4.0");
req.setRequestHeader("OData-Version", "4.0");
req.setRequestHeader("Accept", "application/json");
req.setRequestHeader("Content-Type", "application/json; charset=utf-8");
req.setRequestHeader("Prefer", "odata.include-annotations=\"*\"");
req.onreadystatechange = function () {
if (this.readyState === 4) {
req.onreadystatechange = null;
if (this.status === 200) {
var results = JSON.parse(this.response);
if (results != null) {
records = results.value;
}
} else {
Xrm.Utility.alertDialog(this.statusText);
}
}
};
req.send();
return records;
};

To fetch records using FetchXML

 

The JavaScript function FetchXML_GetRecords(originalFetch, entityname) that receives FetchXML (originalFetch) and the entity name (entityname) on which the FetchXML has to be run against.

 

Output: ResultSet

 

System Administrator

Sales Person

Sales Manager

Support Professional

Supervisor

 

Summary

 

In my next blog, I will describe how to make use of a security role to show or hide Fields in the Entity Form.