Skip to main content
Version: 8.1

hasRole

This function is used by Ignition's Expression language..

Description

Returns true if the user has the given role. The username and usersource parameters are optional in the client scope, but required in the Gateway scope.

Syntax

hasRole(role[, username][, usersource])

  • Parameters

    • String role - The name of a role.

    • String username - A username. Defaults to the current user. [optional]

    • String usersource - The usersource of the username. Defaults to the usersource of the current user. [optional]

  • Results

    • Boolean - True if the specified user has the specified role, False if not.

Examples

Code Snippet
// This is an example using a username and userSource:
hasRole("Administrator", "bob", "default")
Code Snippet
// This is an example using the current user and default userSource in the Client scope:
hasRole("Administrator")