MarkLogic 9 Product Documentation

sec.removeRoleFromUsers

sec.removeRoleFromUsers(
   role-name as String
) as null

Summary

Removes references to the role ($role-name) from all users.

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

If the current user is limited to granting only his/her roles, and $role-name is not a subset of the current user's roles, then an error is returned.

Required Privileges

Usage Notes

This function must be executed against the security database.

Example

// execute this against the security database

declareUpdate();   
const sec = require('/MarkLogic/security.xqy');
   
sec.removeRoleFromUsers("Contractor")

// Removes the "Contractor" role from all users.