MarkLogic 12 EA 1 Product Documentation

sec.externalSecuritySetDescription

sec.externalSecuritySetDescription(
   external-security-name as String,
   description as String
) as null

Summary

This function sets the description for the named external authorization configuration object.

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');

sec.externalSecuritySetDescription('ldapconfig', 'New Description');

// Sets the description of the external authorization configuration object,
// named 'ldapconfig', to 'New Description'.