isUserInRole
Description
Determines whether an authenticated user belongs to the specified Role.
Categories
Related
History
ColdFusion
MX: Added this function.
Syntax
IsUserInRole("role_name")
Attributes
| Attribute | Description | Required | Default |
|---|---|---|---|
| role_name | Name of a security role |
Returns
True,
if the authenticated user, belongs to the specified Role; False,
otherwise.
Usage
Role names are not case-sensitive.
To check if a user is in multiple roles, specify them in a comma-delimited list, such as "Admin,HR". Lists with multiple roles cannot contain spaces as separators; for example, do not use "Admin, HR".
To check if a user is in multiple roles, specify them in a comma-delimited list, such as "Admin,HR". Lists with multiple roles cannot contain spaces as separators; for example, do not use "Admin, HR".
Example
<cfif IsUserInRole("Admin") >
<cfoutput>Authenticated user is an administrator</cfoutput>
<cfelse IsUserInRole("User") >
<cfoutput>Authenticated user is a user</cfoutput>
</cfif>