Retrieving Available User Roles

Description

This operation returns a list of the roles associated with the user account currently logged in to the Backendless application. If the request is sent without logging in, the system will return only one role - NotAuthenticatedUser.

Method

Backendless.UserService.getUserRoles()

Return Value

Returns an array of roles assigned to the currently logged in user

[  
  "roleName 1",   
  "roleName 2"  
  ...  
  "roleName N"  
]

Example

The example below logs in as "alice@wonderland.com", and retrieves the current user roles as an array containing string values.

Before retrieving the user roles, log in as described in the Login section. Then, retrieve the user roles as follows:

Backendless.UserService.login("alice@yourmail.com", "wonderland", true )
 .then( function( loggedInUser ) {
   Backendless.UserService.getUserRoles()
    .then( function( arrayOfUserRoles ) {
      for( var index in arrayOfUserRoles )
        console.log( "user belongs to role: " + arrayOfUserRoles[ index ] ); 
    })
    .catch( function( error ) {
      console.log( "error " + error.message );
    });
  })
 .catch( function( error ) {
   console.log( "error " + error.message );
 });

Codeless Reference

Returns a list containing current user roles.

Consider the following record in the Users data table:

The example below logs in as "alice@wonderland.com", and retrieves the current user roles as a list containing string values.

The output will look as shown below after the Codeless logic runs: