rolesAvailable
- 26 Oct 2020
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
rolesAvailable
- Updated on 26 Oct 2020
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Description
Type: Array
Returns a Javascript array of all possible security roles regardless of whether or not the user belongs to them.
Examples
// display all roles supported by the runtime
for (var i in user.rolesAvailable) {
debug.log(user.rolesAvailable[i]);
}
Remarks
Definition
A role is a security term that refers to a type of user and the set of permissions they have.
IT administrators assign roles to users (according to their job specifications) when the user's account is first set up or when management requests changes. These roles often dictate which product features a user can access.
For example, a Dr. Know user could be a technician using your app to collect certain data elements during patient testing. Later, a physician might use your app to review this information and complete a report. Each user would belong to a distinct role. Users can also belong to more than one role.
You can use this information within your scripts to deliver role-specific features and user experience enhancements.