MarkLogic 10 Product Documentation

sec.roleGetDescription

sec.roleGetDescription(
   role-name as String
) as String

Summary

Returns the description for the specified role.

Required Privileges

Usage Notes

If a role with name equal to $role-name is not found, an error is returned.

This function must be executed against the security database.

Example

// execute this against the security database

const sec = require('/MarkLogic/security.xqy');
   
sec.roleGetDescription("Developer")

=> Developer-level access