---
sourceDocument: Xanadu API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# GlideUser - Scoped

# GlideUser - Scoped {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes to read

The GlideUser API provides methods to access information about the current user and current user roles.

Using the GlideUser API avoids the need to use the slower GlideRecord queries to get user information.

## Scoped GlideUser - getCompanyID() {#ariaid-title2}

Returns the current user's company sys_id.
{#r_ScopedGlideUserGetCompanyID__table_vx2_525_jq__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 1. Parameters]

{#r_ScopedGlideUserGetCompanyID__table_vx2_525_jq} {#r_ScopedGlideUserGetCompanyID__table_qxf_p34_1r__entry__2}

| Type | Description |
|-|-|
| String | Company sys_id. |
[Table 2. Returns]

{#r_ScopedGlideUserGetCompanyID__table_qxf_p34_1r}  

    var currentUser = gs.getUser(); 
    gs.info(currentUser.getCompanyID());

## Scoped GlideUser - getDisplayName() {#ariaid-title3}

Returns the current user's display name.
{#r_ScopedGlideUserGetDisplayName__table_vy2_524_jq__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 3. Parameters]

{#r_ScopedGlideUserGetDisplayName__table_vy2_524_jq} {#r_ScopedGlideUserGetDisplayName__table_asj_cj4_1r__entry__2}

| Type | Description |
|-|-|
| String | User's display name |
[Table 4. Returns]

{#r_ScopedGlideUserGetDisplayName__table_asj_cj4_1r}  

    var currentUser = gs.getUser(); 
    gs.info(currentUser.getDisplayName());

## Scoped GlideUser - getEmail() {#ariaid-title4}

Returns the user's email address.
{#r_SGU-getEmail__table_syp_shb_1x__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 5. Parameters]

{#r_SGU-getEmail__table_syp_shb_1x} {#r_SGU-getEmail__table_typ_shb_1x__entry__2}

| Type | Description |
|-|-|
| String | User's email address. |
[Table 6. Returns]

{#r_SGU-getEmail__table_typ_shb_1x}  

    var currentUser = gs.getUser(); 
    gs.info(currentUser.getEmail());

## Scoped GlideUser - getFirstName() {#ariaid-title5}

Returns the user's first name.
{#r_SGU-getFirstName__table_x5k_h3b_1x__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 7. Parameters]

{#r_SGU-getFirstName__table_x5k_h3b_1x} {#r_SGU-getFirstName__table_y5k_h3b_1x__entry__2}

| Type | Description |
|-|-|
| String | User's first name. |
[Table 8. Returns]

{#r_SGU-getFirstName__table_y5k_h3b_1x}  

    var currentUser = gs.getUser(); 
    gs.info(currentUser.getFirstName());

## Scoped GlideUser - getID() {#ariaid-title6}

Gets the sys_id of the current user.
{#r_ScopedGlideUserGetID__table_vy2_521_jq__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 9. Parameters]

{#r_ScopedGlideUserGetID__table_vy2_521_jq} {#r_ScopedGlideUserGetID__table_bc1_4j4_1r__entry__2}

| Type | Description |
|-|-|
| String | User's sys_id. |
[Table 10. Returns]

{#r_ScopedGlideUserGetID__table_bc1_4j4_1r}  

    var currentUser = gs.getUser(); 
    gs.info(currentUser.getID());

## Scoped GlideUser - getLastName() {#ariaid-title7}

Returns the user's last name.
{#r_SGU-getLastName__table_tkm_t3b_1x__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 11. Parameters]

{#r_SGU-getLastName__table_tkm_t3b_1x} {#r_SGU-getLastName__table_ukm_t3b_1x__entry__2}

| Type | Description |
|-|-|
| String | User's last name. |
[Table 12. Returns]

{#r_SGU-getLastName__table_ukm_t3b_1x}  

    var currentUser = gs.getUser(); 
    gs.info(currentUser.getLastName());

## Scoped GlideUser - getName() {#ariaid-title8}

Returns the user ID, or login name, of the current user.
{#r_ScopedGlideUserGetName__table_vy2_525_eq__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 13. Parameters]

{#r_ScopedGlideUserGetName__table_vy2_525_eq} {#r_ScopedGlideUserGetName__table_ucq_xj4_1r__entry__2}

| Type | Description |
|-|-|
| String | User ID or login name. |
[Table 14. Returns]

{#r_ScopedGlideUserGetName__table_ucq_xj4_1r}  

    var currentUser = gs.getUser(); 
    gs.info(currentUser.getName());

## Scoped GlideUser - getPreference(String name) {#ariaid-title9}

Gets the specified user preference value for the current user.
{#r_ScopedGlideUserGetPreference_String__table_mtf_3k4_1r__entry__3}

| Name | Type | Description |
|-|-|-|
| name | String | Name of the preference. |
[Table 15. Parameters]

{#r_ScopedGlideUserGetPreference_String__table_mtf_3k4_1r} {#r_ScopedGlideUserGetPreference_String__table_otf_3k4_1r__entry__2}

| Type | Description |
|-|-|
| String | Preference value. |
[Table 16. Returns]

{#r_ScopedGlideUserGetPreference_String__table_otf_3k4_1r}  

    var currentUser = gs.getUser(); 
    currentUser.savePreference(­'myPref','red'); 
    gs.info(currentUser.getPreference(­'myPref'));

## Scoped GlideUser - getRoles() {#ariaid-title10}

Returns a list of roles that includes explicitly granted roles, inherited roles, and
roles acquired by group membership.
{#r_SGU-getRoles__table_ukj_xgb_1x__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 17. Parameters]

{#r_SGU-getRoles__table_ukj_xgb_1x} {#r_SGU-getRoles__table_vkj_xgb_1x__entry__2}

| Type | Description |
|-|-|
| Array | List of all roles available to the user |
[Table 18. Returns]

{#r_SGU-getRoles__table_vkj_xgb_1x}  

    var currentUser = gs.getUser(); 
    gs.info(currentUser.getRoles());

## Scoped GlideUser - getUserRoles() {#ariaid-title11}

Returns the list of roles explicitly granted to the user.
Unlike the getRoles() method, this method does not return roles the user
inherits or roles acquired from group membership.
{#r_SGU-getUserRoles__table_jhl_yfb_1x__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 19. Parameters]

{#r_SGU-getUserRoles__table_jhl_yfb_1x} {#r_SGU-getUserRoles__table_khl_yfb_1x__entry__2}

| Type | Description |
|-|-|
| Array | List of roles explicitly assigned to the user. |
[Table 20. Returns]

{#r_SGU-getUserRoles__table_khl_yfb_1x}  

    var currentUser = gs.getUser(); 
    gs.info(currentUser.getUserRoles());

## Scoped GlideUser - hasAssignedRole(String roleName) {#ariaid-title12}

Returns true if the user has the specified role.
{#GUserScoped-hasAssignedRole_S__table_o2s_mlp_ldc__entry__3}

| Name | Type | Description |
|-|-|-|
| roleName | String | Checks if the user has this role. Note: For the current user, this method checks for the role in their [elevated privilege roles](https://www.servicenow.com/docs/access?context=c_ElevatedPrivilege&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US) only if they elevated to that role in the current session. For non current users, this method checks for the role in all of their elevated privilege roles. |
[Table 21. Parameters]

{#GUserScoped-hasAssignedRole_S__table_o2s_mlp_ldc} {#GUserScoped-hasAssignedRole_S__table_p2s_mlp_ldc__entry__2}

| Type | Description |
|-|-|
| Boolean | Flag that indicates whether the user has the specified role. Valid values: * true: The user has the specified role. * false: The user doesn't have the specified role. {#GUserScoped-hasAssignedRole_S__ul_lbx_zmp_ldc} |
[Table 22. Returns]

{#GUserScoped-hasAssignedRole_S__table_p2s_mlp_ldc}  
This example checks if the current user has the admin role.

    var currentUser = gs.getUser();
    gs.info(currentUser.hasAssignedRole('admin'));

Output:

    true

## Scoped GlideUser - hasRole(String role) {#ariaid-title13}

Returns true if the user has the specified role or the admin role.
{#r_ScopedGlideUserHasRole_String__table_gk4_5k4_1r__entry__3}

| Name | Type | Description |
|-|-|-|
| role | String | Checks if the user has this role. |
[Table 23. Parameters]

{#r_ScopedGlideUserHasRole_String__table_gk4_5k4_1r} {#r_ScopedGlideUserHasRole_String__table_ik4_5k4_1r__entry__2}

| Type | Description |
|-|-|
| Boolean | Flag that indicates whether the user has the specified role or the admin role. Valid values: * true: The user has the specified role or the admin role. * false: The user doesn't have the specified role or the admin role. {#r_ScopedGlideUserHasRole_String__ul_lbx_zmp_ldc} |
[Table 24. Returns]

{#r_ScopedGlideUserHasRole_String__table_ik4_5k4_1r}  
This example checks if the current user has the admin role.

    var currentUser = gs.getUser(); 
    gs.info(currentUser.hasRole('admin'));

Output:

    true

## Scoped GlideUser - isMemberOf(String group) {#ariaid-title14}

Determines if the current user is a member of the specified group.
{#r_ScopedGlideUserIsMemberOf_String__table_mck_gl4_1r__entry__3}

| Name | Type | Description |
|-|-|-|
| group | String | Group to check. |
[Table 25. Parameters]

{#r_ScopedGlideUserIsMemberOf_String__table_mck_gl4_1r} {#r_ScopedGlideUserIsMemberOf_String__table_ock_gl4_1r__entry__2}

| Type | Description |
|-|-|
| Boolean | Flag that indicates whether the user is a member of the specified group. Possible values: * true: User is a member of the specified group. * false: User isn't a member of the specified group. {#r_ScopedGlideUserIsMemberOf_String__ul_ytn_2bf_z1c} |
[Table 26. Returns]

{#r_ScopedGlideUserIsMemberOf_String__table_ock_gl4_1r}  

    var currentUser = gs.getUser(); 
    gs.info(currentUser.isMemberOf(­'Capacity Mgmt'));

## Scoped GlideUser - savePreference(String name, String value) {#ariaid-title15}

Saves a user preference value to the database.
{#r_ScopedGlideUserSavePreference_String_String__table_wyt_rl4_1r__entry__3}

| Name | Type | Description |
|-|-|-|
| name | String | Preference to save. |
| value | String | Preference value. |
[Table 27. Parameters]

{#r_ScopedGlideUserSavePreference_String_String__table_wyt_rl4_1r} {#r_ScopedGlideUserSavePreference_String_String__table_xyt_rl4_1r__entry__2}

| Type | Description |
|-|-|
| None |   |
[Table 28. Returns]

{#r_ScopedGlideUserSavePreference_String_String__table_xyt_rl4_1r}  

    var currentUser = gs.getUser(); 
    currentUser.savePreference('myPref','red'); 
    gs.info(currentUser.getPreference('myPref'));