XQuery admin:appserver-set-ssl-require-client-certificate

MarkLogic Server 11.0 Product Documentation
admin.appserverSetSslRequireClientCertificate

admin.appserverSetSslRequireClientCertificate(
   config as element(configuration),
   appserver-id as (Number|String),
   value as Boolean
) as element(configuration)

Summary

This function determines whether or not a client certificate is required 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.
value	A boolean value, `true` to enable, `false` to disable.

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 appServer = admin.appserverGetId(config,
          admin.groupGetId(config, "Default"),
          "Docs")
      admin.appserverSetSslRequireClientCertificate(config, appServer, fn.false())

   //Specifies that the "Docs" App Server does not require a client certificate.
   //Use admin.saveConfiguration to save the changes to the configuration
   //or pass the configuration to other Admin API functions to make other changes.

MarkLogic Server 11.0 Product Documentationadmin.appserverSetSslRequireClientCertificate

Summary

Required Privileges

Example

MarkLogic Server 11.0 Product Documentation
admin.appserverSetSslRequireClientCertificate