IsUserInRole |
|
 |
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
|
Authentication functions, Decision functions
|
|
Function syntax |
IsUserInRole("role_name")
|
|
See also
|
GetAuthUser, cflogin, cfloginuser, Chapter 16, "Securing Applications," in Developing ColdFusion MX Applications
|
|
History
|
ColdFusion MX: Added this function.
|
|
Parameters
|
|
Parameter |
Description |
role_name |
Name of a security role |
|
|
Usage
|
Role names are 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>
|