Whatever message this page gives is out now! Go check it out!
IsUserInRole
Last update:
May 18, 2026
Description
Determines whether an authenticated user belongs to the specified Role.
Returns
True, if the authenticated user, belongs to the specified Role; False, otherwise.
Category
Function syntax
IsUserInRole("role_name")See also
cflogin, cfloginuser, GetAuthUser, GetUserRoles, IsUserInAnyRole, IsUserLoggedIn, Securing Applications in the Developing ColdFusion Applications
History
ColdFusion MX: Added this function.
Parameters
Parameter | Description |
role_name | Name of a security role |
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".
Example
<cfif IsUserInRole("Admin") >
<cfoutput>Authenticated user is an administrator</cfoutput>
<cfelse IsUserInRole("User") >
<cfoutput>Authenticated user is a user</cfoutput>
</cfif>Note:
From ColdFusion 11 onwards, this function is not applicable when a user is logged in using Admin API.
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Share additional feedback to help us improve.
0/255
|
