XQuery admin:appserver-set-external-security

MarkLogic 12 EA 1 Product Documentation
admin.appserverSetExternalSecurity

admin.appserverSetExternalSecurity(
   config as element(configuration),
   appserver-id as (Number|String),
   external-security-names as String[],
   internal-security as Boolean,
   authentication as String
) as element(configuration)

Summary

This function sets the external security setting in the configuration for the specified App Server.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
appserver-id The ID of the App Server. Typically, this is the result of an admin.appserverGetId call.
external-security-names The name of the External Security Config.
internal-security A boolean value specifying whether the security database is used for authentication and authorization.
authentication The authentication scheme (basic, digest, digestbasic, application-level, kerberos-ticket, or certificate).

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/app-server-security

http://marklogic.com/xdmp/privileges/admin/app-server-security/{id}

http://marklogic.com/xdmp/privileges/admin/group-security

http://marklogic.com/xdmp/privileges/admin/group-security/{id}

Example

const admin = require('/MarkLogic/admin.xqy');
const config = admin.getConfiguration()
const groupid = admin.groupGetId(config, "Default")
admin.appserverSetExternalSecurity(config,
           admin.appserverGetId(config, groupid, "myAppServer"),
           "myLdapConfig",fn.true(),"basic")
   => returns the new configuration element -- use admin.saveConfiguration
      to save the changes to the configuration or pass the configuration
      to other Admin API functions to make other changes.

Example

const admin = require('/MarkLogic/admin.xqy');
const config = admin.getConfiguration()
const groupid = admin.groupGetId(config, "Default")
admin.appserverSetExternalSecurity(config,
           admin.appserverGetId(config, groupid, "myAppServer"),
           "myKerberosConfig",fn.false(),"kerberosTicket")
   => returns the new configuration element -- use admin.saveConfiguration
      to save the changes to the configuration or pass the configuration
      to other Admin API functions to make other changes.
Powered by MarkLogic Server | Terms of Use | Privacy Policy