mlclient.calls package

The ML Calls package.

It contains modules dealing with MarkLogic REST Resources at the lowest level of HTTP requests. Additionally, it exports the following package:

  • model

    The ML Calls Model package.

This package exports the following modules:

  • resource_call

    An abstract class representing a single request to a MarkLogic REST Resource.

  • database_call

    The ML Database Resource Calls module.

  • database_properties_call

    The ML Database Properties Resource Calls module.

  • databases_call

    The ML Databases Resource Calls module.

  • documents_call

    The ML Documents Resource Calls module.

  • eval_call

    The ML Eval Resource Call module.

  • forest_call

    The ML Forest Resource Calls module.

  • forest_properties_call

    The ML Forest Properties Resource Calls module.

  • forests_call

    The ML Forests Resource Calls module.

  • logs_call

    The ML Logs Resource Call module.

  • role_call

    The ML Role Resource Calls module.

  • role_properties_call

    The ML Role Properties Resource Calls module.

  • roles_call

    The ML Roles Resource Calls module.

  • server_call

    The ML Server Resource Calls module.

  • server_properties_call

    The ML Server Properties Resource Calls module.

  • servers_call

    The ML Servers Resource Calls module.

  • user_call

    The ML User Resource Calls module.

  • user_properties_call

    The ML User Properties Resource Calls module.

  • users_call

    The ML Users Resource Calls module.

This package exports the following classes:
  • ResourceCall

    An abstract class representing a single request to a MarkLogic REST Resource.

  • DatabaseGetCall

    A GET request to get database details.

  • DatabasePostCall

    A POST request to manage a database.

  • DatabaseDeleteCall

    A DELETE request to remove a database from a cluster.

  • DatabasePropertiesGetCall

    A GET request to get a database properties.

  • DatabasePropertiesPutCall

    A PUT request to modify database properties.

  • DatabasesGetCall

    A GET request to get databases summary.

  • DatabasesPostCall

    A POST request to create a new database.

  • DocumentsGetCall

    A GET request to retrieve documents’ content or metadata.

  • DocumentsDeleteCall

    A DELETE request to remove documents, or reset document metadata.

  • DocumentsPostCall

    A POST request to insert or update documents’ content or metadata.

  • EvalCall

    A POST request to evaluate an ad-hoc query.

  • ForestGetCall

    A GET request to get a forest details.

  • ForestPostCall

    A POST request to change a forest’s state.

  • ForestDeleteCall

    A DELETE request to remove a forest.

  • ForestPropertiesGetCall

    A GET request to get forest properties.

  • ForestPropertiesPutCall

    A PUT request to modify forest properties.

  • ForestsGetCall

    A GET request to get forests summary.

  • ForestsPostCall

    A POST request to create a new forest.

  • ForestsPutCall

    A PUT request to perform an operation on forests.

  • LogsCall

    A GET request to retrieve logs.

  • RoleGetCall

    A GET request to get a role details.

  • RoleDeleteCall

    A DELETE request to remove a role.

  • RolePropertiesGetCall

    A GET request to get role properties.

  • RolePropertiesPutCall

    A PUT request to modify role properties.

  • RolesGetCall

    A GET request to get roles summary.

  • RolesPostCall

    A POST request to create a new role.

  • ServerGetCall

    A GET request to get app server details.

  • ServerDeleteCall

    A DELETE request to remove an app server.

  • ServerPropertiesGetCall

    A GET request to get app server properties.

  • ServerPropertiesPutCall

    A PUT request to modify app server properties.

  • ServersGetCall

    A GET request to get app servers summary.

  • ServersPostCall

    A POST request to create a new app server.

  • UserGetCall

    A GET request to get user details.

  • UserDeleteCall

    A DELETE request to remove a user.

  • UserPropertiesGetCall

    A GET request to get user properties.

  • UserPropertiesPutCall

    A PUT request to modify user properties.

  • UsersGetCall

    A GET request to get users summary.

  • UsersPostCall

    A POST request to create a new user.

Examples

>>> from mlclient.calls import DatabaseGetCall, EvalCall
class mlclient.calls.DatabaseDeleteCall(database: str, forest_delete: str | None = None)[source]

Bases: ResourceCall

A DELETE request to remove a database from a cluster.

A ResourceCall implementation representing a single DELETE request to the /manage/v2/databases/{id|name} REST Resource.

This resource address deletes the named database from the cluster. The database can be identified either by id or name. Documentation of the REST Resource API: https://docs.marklogic.com/REST/DELETE/manage/v2/databases/[id-or-name]

property endpoint

An endpoint for the Database call.

Returns:

A Database call endpoint

Return type:

str

class mlclient.calls.DatabaseGetCall(database: str, data_format: str = 'xml', view: str = 'default')[source]

Bases: ResourceCall

A GET request to get database details.

A ResourceCall implementation representing a single GET request to the /manage/v2/databases/{id|name} REST Resource.

This resource address returns information on the specified database. The database can be identified either by ID or name. Documentation of the REST Resource API: https://docs.marklogic.com/REST/GET/manage/v2/databases/[id-or-name]

property endpoint

An endpoint for the Database call.

Returns:

A Database call endpoint

Return type:

str

class mlclient.calls.DatabasePostCall(database: str, body: str | dict)[source]

Bases: ResourceCall

A POST request to manage a database.

A ResourceCall implementation representing a single POST request to the /manage/v2/databases/{id|name} REST Resource.

This resource address can be used to clear the contents of the named database and to perform various configuration operations on the database. The database can be identified either by id or name. Documentation of the REST Resource API: https://docs.marklogic.com/REST/POST/manage/v2/databases/[id-or-name]

property endpoint

An endpoint for the Database call.

Returns:

A Database call endpoint

Return type:

str

class mlclient.calls.DatabasePropertiesGetCall(database: str, data_format: str = 'xml')[source]

Bases: ResourceCall

A GET request to get a database properties.

A ResourceCall implementation representing a single GET request to the /manage/v2/databases/{id|name}/properties REST Resource.

This resource address returns the modifiable properties of the named database. The database can be identified either by ID or name. Documentation of the REST Resource API: https://docs.marklogic.com/REST/GET/manage/v2/databases/[id-or-name]/properties

property endpoint

An endpoint for the Database Properties call.

Returns:

A Database Properties call endpoint

Return type:

str

class mlclient.calls.DatabasePropertiesPutCall(database: str, body: str | dict)[source]

Bases: ResourceCall

A PUT request to modify database properties.

A ResourceCall implementation representing a single PUT request to the /manage/v2/databases/{id|name}/properties REST Resource.

This resource address modifies the properties of the named database. The list of modifiable properties can be returned by the GET version of this endpoint. The database can be identified either by id or name. Documentation of the REST Resource API: https://docs.marklogic.com/REST/PUT/manage/v2/databases/[id-or-name]/properties

property endpoint

An endpoint for the Database Properties call.

Returns:

A Database Properties call endpoint

Return type:

str

class mlclient.calls.DatabasesGetCall(data_format: str = 'xml', view: str = 'default')[source]

Bases: ResourceCall

A GET request to get databases summary.

A ResourceCall implementation representing a single GET request to the /manage/v2/databases REST Resource.

This resource address returns a summary of the databases in the cluster. Documentation of the REST Resource API: https://docs.marklogic.com/REST/GET/manage/v2/databases

property endpoint

An endpoint for the Databases call.

Returns:

A Databases call endpoint

Return type:

str

class mlclient.calls.DatabasesPostCall(body: str | dict)[source]

Bases: ResourceCall

A POST request to create a new database.

A ResourceCall implementation representing a single POST request to the /manage/v2/databases REST Resource.

This resource address creates a new database in the cluster. Documentation of the REST Resource API: https://docs.marklogic.com/REST/POST/manage/v2/databases

property endpoint

An endpoint for the Databases call.

Returns:

A Databases call endpoint

Return type:

str

class mlclient.calls.DocumentsDeleteCall(uri: str | list, database: str | None = None, category: str | list | None = None, txid: str | None = None, temporal_collection: str | None = None, system_time: str | None = None, wipe_temporal: bool | None = None)[source]

Bases: ResourceCall

A DELETE request to remove documents, or reset document metadata.

A ResourceCall implementation representing a single DELETE request to the /v1/documents REST Resource.

Retrieve document content and/or metadata from the database. Documentation of the REST Resource API: https://docs.marklogic.com/REST/DELETE/v1/documents

property endpoint

An endpoint for the Documents call.

Returns:

A Documents call endpoint

Return type:

str

class mlclient.calls.DocumentsGetCall(uri: str | list, database: str | None = None, category: str | list | None = None, data_format: str | None = None, timestamp: str | None = None, transform: str | None = None, transform_params: dict | None = None, txid: str | None = None)[source]

Bases: ResourceCall

A GET request to retrieve documents’ content or metadata.

A ResourceCall implementation representing a single GET request to the /v1/documents REST Resource.

Retrieve document content and/or metadata from the database. Documentation of the REST Resource API: https://docs.marklogic.com/REST/GET/v1/documents

property endpoint

An endpoint for the Documents call.

Returns:

A Documents call endpoint

Return type:

str

class mlclient.calls.DocumentsPostCall(body_parts: list[mlclient.structures.calls.documents.DocumentsBodyPart], database: str | None = None, transform: str | None = None, transform_params: dict | None = None, txid: str | None = None, temporal_collection: str | None = None, system_time: str | None = None)[source]

Bases: ResourceCall

A POST request to insert or update documents’ content or metadata.

A ResourceCall implementation representing a single POST request to the /v1/documents REST Resource.

Insert or update content and/or metadata for multiple documents in a single request. Documentation of the REST Resource API: https://docs.marklogic.com/REST/POST/v1/documents

property endpoint

An endpoint for the Documents call.

Returns:

A Documents call endpoint

Return type:

str

class mlclient.calls.EvalCall(xquery: str | None = None, javascript: str | None = None, variables: dict | None = None, database: str | None = None, txid: str | None = None)[source]

Bases: ResourceCall

A POST request to evaluate an ad-hoc query.

A ResourceCall implementation representing a single request to the /v1/eval REST Resource.

Evaluate an ad-hoc query expressed using XQuery or server-side JavaScript. Documentation of the REST Resource API: https://docs.marklogic.com/REST/POST/v1/eval

property endpoint

An endpoint for the Eval call.

Returns:

An Eval call endpoint

Return type:

str

class mlclient.calls.ForestDeleteCall(forest: str, level: str, replicas: str | None = None)[source]

Bases: ResourceCall

A DELETE request to remove a forest.

A ResourceCall implementation representing a single DELETE request to the /manage/v2/forests/{id|name} REST Resource.

Delete a forest. Documentation of the REST Resource API: https://docs.marklogic.com/REST/DELETE/manage/v2/forests/[id-or-name]

property endpoint

An endpoint for the Forest call.

Returns:

A Forest call endpoint

Return type:

str

class mlclient.calls.ForestGetCall(forest: str, data_format: str = 'xml', view: str = 'default')[source]

Bases: ResourceCall

A GET request to get a forest details.

A ResourceCall implementation representing a single GET request to the /manage/v2/forests/{id|name} REST Resource.

Retrieve information about a forest. The forest can be identified either by id or name. Documentation of the REST Resource API: https://docs.marklogic.com/REST/GET/manage/v2/forests/[id-or-name]

property endpoint

An endpoint for the Forest call.

Returns:

A Forest call endpoint

Return type:

str

class mlclient.calls.ForestPostCall(forest: str, body: dict)[source]

Bases: ResourceCall

A POST request to change a forest’s state.

A ResourceCall implementation representing a single POST request to the /manage/v2/forests/{id|name} REST Resource.

Initiate a state change on a forest, such as a merge, restart, or attach. Documentation of the REST Resource API: https://docs.marklogic.com/REST/POST/manage/v2/forests/[id-or-name]

property endpoint

An endpoint for the Forests call.

Returns:

A Forests call endpoint

Return type:

str

class mlclient.calls.ForestPropertiesGetCall(forest: str, data_format: str = 'xml')[source]

Bases: ResourceCall

A GET request to get forest properties.

A ResourceCall implementation representing a single GET request to the /manage/v2/forests/{id|name}/properties REST Resource.

Retrieve the current state of modifiable properties of the forest identified by {id|name}. Documentation of the REST Resource API: https://docs.marklogic.com/REST/GET/manage/v2/forests/[id-or-name]/properties

property endpoint

An endpoint for the Forest Properties call.

Returns:

A Forest Properties call endpoint

Return type:

str

class mlclient.calls.ForestPropertiesPutCall(forest: str, body: str | dict)[source]

Bases: ResourceCall

A PUT request to modify forest properties.

A ResourceCall implementation representing a single PUT request to the /manage/v2/forests/{id|name}/properties REST Resource.

Modify the configuration of the forest identified by {id|name}. Documentation of the REST Resource API: https://docs.marklogic.com/REST/PUT/manage/v2/forests/[id-or-name]/properties

property endpoint

An endpoint for the Forest Properties call.

Returns:

A Forest Properties call endpoint

Return type:

str

class mlclient.calls.ForestsGetCall(data_format: str = 'xml', view: str = 'default', database: str | None = None, group: str | None = None, host: str | None = None, full_refs: bool | None = None)[source]

Bases: ResourceCall

A GET request to get forests summary.

A ResourceCall implementation representing a single GET request to the /manage/v2/forests REST Resource.

This resource address returns data about the forests in the cluster. The data returned depends on the view. If no view is specified, this request returns a summary of the forests in the cluster. Documentation of the REST Resource API: https://docs.marklogic.com/REST/GET/manage/v2/forests

property endpoint

An endpoint for the Forests call.

Returns:

A Forests call endpoint

Return type:

str

class mlclient.calls.ForestsPostCall(body: str | dict, wait_for_forest_to_mount: bool | None = None)[source]

Bases: ResourceCall

A POST request to create a new forest.

A ResourceCall implementation representing a single POST request to the /manage/v2/forests REST Resource.

Create a new forest, including replicas if specified. If a database id or database is included, attach the new forest(s) to the database. Documentation of the REST Resource API: https://docs.marklogic.com/REST/POST/manage/v2/forests

property endpoint

An endpoint for the Forests call.

Returns:

A Forests call endpoint

Return type:

str

class mlclient.calls.ForestsPutCall(body: str | dict)[source]

Bases: ResourceCall

A PUT request to perform an operation on forests.

A ResourceCall implementation representing a single PUT request to the /manage/v2/forests REST Resource.

Perform an operation on one or more forests, such as combining multiple forests into a single new one, or migrating the data in the forests to a new data directory. Documentation of the REST Resource API: https://docs.marklogic.com/REST/PUT/manage/v2/forests

property endpoint

An endpoint for the Forests call.

Returns:

A Forests call endpoint

Return type:

str

class mlclient.calls.LogsCall(filename: str, data_format: str = 'html', host: str | None = None, start_time: str | None = None, end_time: str | None = None, regex: str | None = None)[source]

Bases: ResourceCall

A GET request to retrieve logs.

A ResourceCall implementation representing a single GET request to the /manage/v2/logs REST Resource.

Returns the content of server log files. Documentation of the REST Resource API: https://docs.marklogic.com/REST/GET/manage/v2/logs

property endpoint

An endpoint for the Logs call.

Returns:

A Logs call endpoint

Return type:

str

class mlclient.calls.ResourceCall(method: str = 'GET', params: dict | None = None, headers: dict | None = None, body: str | dict | bytes | None = None, accept: str | None = None, content_type: str | None = None)[source]

Bases: object

An abstract class representing a single request to a MarkLogic REST Resource.

add_header(header_name: str, header_value: Any)[source]

Put a request header if it’s name and value exist.

Parameters:

  • header_name (str) – a request header name

  • header_value (Any) – a request header value

add_param(param_name: str, param_value: Any)[source]

Put a request parameter if it’s name and value exist.

Parameters:

  • param_name (str) – a request parameter name

  • param_value (Any) – a request parameter value

property body: str | dict | bytes | None

A request body.

Returns:

a request body

Return type:

str | dict

abstract property endpoint: str

An endpoint of the ResourceCall.

Returns:

An endpoint

Return type:

str

property headers: dict

Request headers.

Returns:

request headers

Return type:

dict

property method: str

A request method.

Returns:

a request method

Return type:

str

property params: dict

Request parameters.

Returns:

request parameters

Return type:

dict

class mlclient.calls.RoleDeleteCall(role: str)[source]

Bases: ResourceCall

A DELETE request to remove a role.

A ResourceCall implementation representing a single DELETE request to the /manage/v2/roles/{id|name} REST Resource.

This resource address deletes the named role from the named security database. Documentation of the REST Resource API: https://docs.marklogic.com/REST/DELETE/manage/v2/roles/[id-or-name]

property endpoint

An endpoint for the Role call.

Returns:

A Role call endpoint

Return type:

str

class mlclient.calls.RoleGetCall(role: str, data_format: str = 'xml', view: str = 'default')[source]

Bases: ResourceCall

A GET request to get a role details.

A ResourceCall implementation representing a single GET request to the /manage/v2/roles/{id|name} REST Resource.

This resource address returns the configuration for the specified role. Documentation of the REST Resource API: https://docs.marklogic.com/REST/GET/manage/v2/roles/[id-or-name]

property endpoint

An endpoint for the Role call.

Returns:

A Role call endpoint

Return type:

str

class mlclient.calls.RolePropertiesGetCall(role: str, data_format: str = 'xml')[source]

Bases: ResourceCall

A GET request to get role properties.

A ResourceCall implementation representing a single GET request to the /manage/v2/roles/{id|name}/properties REST Resource.

This resource address returns the properties of the specified role. Documentation of the REST Resource API: https://docs.marklogic.com/REST/GET/manage/v2/roles/[id-or-name]/properties

property endpoint

An endpoint for the Role Properties call.

Returns:

A Role Properties call endpoint

Return type:

str

class mlclient.calls.RolePropertiesPutCall(role: str, body: str | dict)[source]

Bases: ResourceCall

A PUT request to modify role properties.

A ResourceCall implementation representing a single PUT request to the /manage/v2/roles/{id|name}/properties REST Resource.

This resource address can be used to update the properties for the specified role. Documentation of the REST Resource API: https://docs.marklogic.com/REST/PUT/manage/v2/roles/[id-or-name]/properties

property endpoint

An endpoint for the Role Properties call.

Returns:

A Role Properties call endpoint

Return type:

str

class mlclient.calls.RolesGetCall(data_format: str = 'xml', view: str = 'default')[source]

Bases: ResourceCall

A GET request to get roles summary.

A ResourceCall implementation representing a single GET request to the /manage/v2/roles REST Resource.

This resource address returns a summary of the roles in the security database. Documentation of the REST Resource API: https://docs.marklogic.com/REST/GET/manage/v2/roles

property endpoint

An endpoint for the Roles call.

Returns:

A Roles call endpoint

Return type:

str

class mlclient.calls.RolesPostCall(body: str | dict)[source]

Bases: ResourceCall

A POST request to create a new role.

A ResourceCall implementation representing a single POST request to the /manage/v2/roles REST Resource.

This resource address creates a new role in the security database. Documentation of the REST Resource API: https://docs.marklogic.com/REST/POST/manage/v2/roles

property endpoint

An endpoint for the Roles call.

Returns:

A Roles call endpoint

Return type:

str

class mlclient.calls.ServerDeleteCall(server: str, group_id: str)[source]

Bases: ResourceCall

A DELETE request to remove an app server.

A ResourceCall implementation representing a single DELETE request to the /manage/v2/servers/{id|name} REST Resource.

This resource address deletes the specified App Server from the specified group. Documentation of the REST Resource API: https://docs.marklogic.com/REST/DELETE/manage/v2/servers/[id-or-name]

property endpoint

An endpoint for the Server call.

Returns:

A Server call endpoint

Return type:

str

class mlclient.calls.ServerGetCall(server: str, group_id: str, data_format: str = 'xml', view: str = 'default', host_id: str | None = None, full_refs: bool | None = None, modules: bool | None = None)[source]

Bases: ResourceCall

A GET request to get app server details.

A ResourceCall implementation representing a single GET request to the /manage/v2/servers/{id|name} REST Resource.

This resource address returns data about a specific App Server. The server can be identified either by id or name. The data returned depends on the value of the view request parameter. The default view is a summary with links to additional data. Documentation of the REST Resource API: https://docs.marklogic.com/REST/GET/manage/v2/servers/[id-or-name]

property endpoint

An endpoint for the Server call.

Returns:

A Server call endpoint

Return type:

str

class mlclient.calls.ServerPropertiesGetCall(server: str, group_id: str, data_format: str = 'xml')[source]

Bases: ResourceCall

A GET request to get app server properties.

A ResourceCall implementation representing a single GET request to the /manage/v2/servers/{id|name}/properties REST Resource.

This resource address returns the current state of modifiable properties of the specified App Server. Documentation of the REST Resource API: https://docs.marklogic.com/REST/GET/manage/v2/servers/[id-or-name]/properties

property endpoint

An endpoint for the Server Properties call.

Returns:

A Server Properties call endpoint

Return type:

str

class mlclient.calls.ServerPropertiesPutCall(server: str, group_id: str, body: str | dict)[source]

Bases: ResourceCall

A PUT request to modify app server properties.

A ResourceCall implementation representing a single PUT request to the /manage/v2/servers/{id|name}/properties REST Resource.

Initiate a properties change on the specified App Server. Documentation of the REST Resource API: https://docs.marklogic.com/REST/PUT/manage/v2/servers/[id-or-name]/properties

property endpoint

An endpoint for the Server Properties call.

Returns:

A Server Properties call endpoint

Return type:

str

class mlclient.calls.ServersGetCall(data_format: str = 'xml', group_id: str | None = None, view: str = 'default', full_refs: bool | None = None)[source]

Bases: ResourceCall

A GET request to get app servers summary.

A ResourceCall implementation representing a single GET request to the /manage/v2/servers REST Resource.

This resource address returns data about the App Servers in the cluster. The data returned depends on the setting of the view request parameter. The default view provides a summary of the servers. Documentation of the REST Resource API: https://docs.marklogic.com/REST/GET/manage/v2/servers

property endpoint

An endpoint for the Servers call.

Returns:

A Servers call endpoint

Return type:

str

class mlclient.calls.ServersPostCall(body: str | dict, group_id: str | None = None, server_type: str | None = None)[source]

Bases: ResourceCall

A POST request to create a new app server.

A ResourceCall implementation representing a single POST request to the /manage/v2/servers REST Resource.

This resource address is used to create a new App Server in the specified group. Documentation of the REST Resource API: https://docs.marklogic.com/REST/POST/manage/v2/servers

property endpoint

An endpoint for the Servers call.

Returns:

A Servers call endpoint

Return type:

str

class mlclient.calls.UserDeleteCall(user: str)[source]

Bases: ResourceCall

A DELETE request to remove a user.

A ResourceCall implementation representing a single DELETE request to the /manage/v2/users/{id|name} REST Resource.

This resource address deletes the named user from the named security database. Documentation of the REST Resource API: https://docs.marklogic.com/REST/DELETE/manage/v2/users/[id-or-name]

property endpoint

An endpoint for the User call.

Returns:

An User call endpoint

Return type:

str

class mlclient.calls.UserGetCall(user: str, data_format: str = 'xml', view: str = 'default')[source]

Bases: ResourceCall

A GET request to get user details.

A ResourceCall implementation representing a single GET request to the /manage/v2/users/{id|name} REST Resource.

This resource address returns the configuration for the specified user. Documentation of the REST Resource API: https://docs.marklogic.com/REST/GET/manage/v2/users/[id-or-name]

property endpoint

An endpoint for the User call.

Returns:

An User call endpoint

Return type:

str

class mlclient.calls.UserPropertiesGetCall(user: str, data_format: str = 'xml')[source]

Bases: ResourceCall

A GET request to get user properties.

A ResourceCall implementation representing a single GET request to the /manage/v2/users/{id|name}/properties REST Resource.

This resource address returns the properties of the specified user. Documentation of the REST Resource API: https://docs.marklogic.com/REST/GET/manage/v2/users/[id-or-name]/properties

property endpoint

An endpoint for the User Properties call.

Returns:

An User Properties call endpoint

Return type:

str

class mlclient.calls.UserPropertiesPutCall(user: str, body: str | dict)[source]

Bases: ResourceCall

A PUT request to modify user properties.

A ResourceCall implementation representing a single PUT request to the /manage/v2/users/{id|name}/properties REST Resource.

This resource address can be used to update the properties for the specified user. Documentation of the REST Resource API: https://docs.marklogic.com/REST/PUT/manage/v2/users/[id-or-name]/properties

property endpoint

An endpoint for the User Properties call.

Returns:

An User Properties call endpoint

Return type:

str

class mlclient.calls.UsersGetCall(data_format: str = 'xml', view: str = 'default')[source]

Bases: ResourceCall

A GET request to get users summary.

A ResourceCall implementation representing a single GET request to the /manage/v2/users REST Resource.

This resource address returns a summary of the users in the cluster. Documentation of the REST Resource API: https://docs.marklogic.com/REST/GET/manage/v2/users

property endpoint

An endpoint for the Users call.

Returns:

An Users call endpoint

Return type:

str

class mlclient.calls.UsersPostCall(body: str | dict)[source]

Bases: ResourceCall

A POST request to create a new user.

A ResourceCall implementation representing a single POST request to the /manage/v2/users REST Resource.

This resource address creates a new user in the security database. Documentation of the REST Resource API: https://docs.marklogic.com/REST/POST/manage/v2/users

property endpoint

An endpoint for the Users call.

Returns:

An Users call endpoint

Return type:

str