JavaScript admin.appserverSetSslRequireClientCertificate

MarkLogic Server 11.0 Product Documentation
admin:appserver-set-ssl-require-client-certificate

admin:appserver-set-ssl-require-client-certificate(
   $config as element(configuration),
   $appserver-id as xs:unsignedLong,
   $value as xs: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:appserver-get-id` call.
value	A boolean value, `fn:true()` to enable, `fn: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


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  let $appServer := admin:appserver-get-id($config,
          admin:group-get-id($config, "Default"),
          "Docs")

  return
      admin:appserver-set-ssl-require-client-certificate($config, $appServer, fn:false())

  (: Specifies that the "Docs" App Server does not require a client certificate.
     Use admin:save-configuration 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:appserver-set-ssl-require-client-certificate

Summary

Required Privileges

Example

MarkLogic Server 11.0 Product Documentation
admin:appserver-set-ssl-require-client-certificate