MarkLogic 10 Product Documentationsec.userGetDescription
sec.userGetDescription( user-name as String ) as String
Summary
Returns the user's description. If a user with name equal to $user-name is not found, an error is returned.
| Parameters | |
|---|---|
| user-name | The name of a user. |
Required Privileges
http://marklogic.com/xdmp/privileges/user-get-descriptionor the current user is the same as the $user-name.
Usage Notes
This function must be executed against the security database.
Example
// execute this against the security database
const sec = require('/MarkLogic/security.xqy');
sec.userGetDescription("Jim")
=>
Jim the temp