MarkLogic 12 Product Documentation

POST /manage/v2/protected-collections

Summary

This resource address creates a new protected collection in the security database.

Response

Upon success, MarkLogic Server returns status code 201 (Created). If the protected collection already exists or if the payload is malformed, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

• the manage-admin and security role
• the following privileges:

  http://marklogic.com/xdmp/privileges/manage

  http://marklogic.com/xdmp/privileges/manage-admin

  http://marklogic.com/xdmp/privileges/collection-get-permissions

Usage Notes

The structure of the data in the request body is shown here. The collection and permissions properties are required.

Note: The properties described here are for XML payloads. In general they are the same for JSON, with the exception that, in JSON, permissions is expressed in singular form. For example, in JSON, permissions is instead permission and the format is: "permission":[{"role-name":"name", "capability":"cap"}].

collection

The collection uri.

permissions

The default set of permissions used in document creation.

This is a complex structure with the following children:

permission

Permission representation.

This is a complex structure with the following children:

role-name

The Role name (unique)

capability

The action/task permitted by a permission

Example

  cat collection.json
  ==>
   {
     "collection": "http://example.org",
     "permission": [
       {
         "role-name": "view-admin",
         "capability": "read"
       }
     ]
   }
  
  curl -X POST  --anyauth -u admin:admin --header "Content-Type:application/json" \
  -d @collection.json http://localhost:8002/manage/v2/protected-collections

  ==>  Creates a collection with the URI "http://example.org" in the Security database.