XQuery admin:appserver-set-API-token-authentication

MarkLogic 12 Product Documentation
admin.appserverSetAPITokenAuthentication

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

Summary

This function sets the API token authentication option for the specified App Server. When set as true, the App Server will accept MarkLogic issued API tokens to perform related task. For example, this option must be turned on on a Join Host of a dynamic host join process. So a dynamic host can communicate with a Join Host to join the cluster.

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	When setting as true, the app server will be able to check if a token is a valid MarkLogic issued API tokens. When setting as false, the app server will reject all MarkLogic issued API tokens.

Required Privileges

This operation requires at least one of the following privileges:

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

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

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

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

Example


  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  const groupid = admin.groupGetId(config, "Default")
  admin.appserverSetAPITokenAuthentication(config,
         admin.appserverGetId(config, groupid, "Admin"),
         true)

   //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.

MarkLogic 12 Product Documentationadmin.appserverSetAPITokenAuthentication

Summary

Required Privileges

Example

MarkLogic 12 Product Documentation
admin.appserverSetAPITokenAuthentication