ServiceNow User Object Cheat Sheet
GlideSystem User Object
The GlideSystem (gs) user object is designed to be used in any server-side JavaScript (Business rules, UI Actions, System security, etc.). The following table shows how to use this object and its corresponding functions and methods.
Function/Method | Return Value |
---|---|
gs.getUser() | Returns a reference to the user object for the currently logged-in user.
Example: var userObject = gs.getUser(); |
gs.getUserByID() | Returns a reference to the user object for the user ID (or sys_id) provided.
Example: var userObject = gs.getUser().getUserByID(’employee’); |
gs.getUserName() | Returns the User ID (user_name) for the currently logged-in user.
Example: var user_name = gs.getUserName(); |
gs.getUserDisplayName() | Returns the display value for the currently logged-in user.
Example: var userDisplay = gs.getUserDisplayName(); |
gs.getUserID() | Returns the sys_id string value for the currently logged-in user.
Example: var userID = gs.getUserID(); |
getFirstName() | Returns the first name of the currently logged-in user.
Example: var firstName = gs.getUser().getFirstName(); |
getLastName() | Returns the last name of the currently logged-in user.
Example: var lastName = gs.getUser().getLastName(); |
getEmail() | Returns the email address of the currently logged-in user.
Example: var email = gs.getUser().getEmail(); |
getDepartmentID() | Returns the department sys_id of the currently logged-in user.
Example: var deptID = gs.getUser().getDepartmentID(); |
getCompanyID() | Returns the company sys_id of the currently logged-in user.
Example: var companyID = gs.getUser().getCompanyID(); |
getCompanyRecord() | Returns the company GlideRecord of the currently logged-in user.
Example: var company = gs.getUser().getCompanyRecord(); |
getLanguage() | Returns the language of the currently logged-in user.
Example: var language = gs.getUser().getLanguage(); |
getLocation() | Returns the location of the currently logged-in user.
Example: var location = gs.getUser().getLocation(); |
getDomainID() | Returns the domain sys_id of the currently logged-in user (only used for instances using domain separation).
Example: var domainID = gs.getUser().getDomainID(); |
getDomainDisplayValue() | Returns the domain display value of the currently logged-in user (only used for instances using domain separation).
Example: var domainName = gs.getUser().getDomainDisplayValue(); |
getManagerID() | Returns the manager sys_id of the currently logged-in user.
Example: var managerID = gs.getUser().getManagerID(); |
getMyGroups() | Returns a list of all groups that the currently logged-in user is a member of.
Example: var groups = gs.getUser().getMyGroups(); |
isMemberOf() | Returns true if the user is a member of the given group, false otherwise.
Example: Takes either a group sys_id or a group name as an argument. if(gs.getUser().isMemberOf(current.assignment_group)){ var isMember = gs.getUser().isMemberOf(‘Hardware’); To do this for a user that isn’t the currently logged-in user… var user = ‘admin’; else{ |
gs.hasRole() | Returns true if the user has the given role, false otherwise.
Example: if(gs.hasRole(‘itil’)){ //Do something… } |
gs.hasRole() | Returns true if the user has one of the given roles, false otherwise.
Example: if(gs.hasRole(‘itil,admin’)){ |
hasRoles() | Returns true if the user has any roles at all, false if the user has no role (i.e. an ess user).
Example: if(!gs.getUser().hasRoles()){ |
g_user User Object
The g_user object can be used only in UI policies and Client scripts. Contrary to its naming, it is not truly a user object. g_user is actually just a handful of cached user properties that are accessible to client-side JavaScript. This eliminates the need for most GlideRecord queries from the client to get user information (which can incur a fairly significant performance hit if not used judiciously).
g_user Property or Method | Return value |
---|---|
g_user.userName | User name of the current user e.g. employee |
g_user.firstName | First name of the current user e.g. Joe |
g_user.lastName | Last name of the current user e.g. Employee |
g_user.userID | sys_id of the current user e.g. 681ccaf9c0a8016400b98a06818d57c7 |
g_user.hasRole() | True if the current user has the role specified, false otherwise. ALWAYS returns true if the user has the ‘admin’ role.
Usage: g_user.hasRole(‘itil’) |
g_user.hasRoleExactly() | True if the current user has the exact role specified, false otherwise, regardless of ‘admin’ role.
Usage: g_user.hasRoleExactly(‘itil’) |
g_user.hasRoles() | True if the current user has at least one role specified, false otherwise.
Usage: g_user.hasRoles(‘itil’,’admin’) |