Loading TOC...

POST /manage/v2/query-rolesets

Summary

This resource endpoint creates a new query roleset using a name or id passed in a payload.

Request Headers
Accept The expected MIME type of the request body. If the format parameter is present, it takes precedence over the Accept header.
Content-type The MIME type of the data in the request body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.

Response

A successful call to the endpoint will return 201 (Created), resulting in the creation of new query rolesets. A response code of 400 (Bad Request) indicates either the query rolesets already exist, or the payload is malformed. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges for this action.

Consumes
application/xml XML Content
application/json JSON Content
Produces
application/json JSON Content
application/xml XML Content

Required Privileges

This operation requires the manage-admin role, or the following privilege:

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

Usage Notes

This request accepts a payload with the following structure.

query-roleset

A query roleset definition

This is a complex structure with the following children:

role-id

A role identifier (unique key).

role-name

The role-name.

Example

> curl -X POST --anyauth -u admin:admin 
	     -d @file.xml -H "Content-Type:application/xml" http://localhost:8002/manage/v2/query-rolesets
    

Payload (as file.xml):

	    <query-roleset-properties xmlns="http://marklogic.com/manage/query-roleset/properties">
	      <query-roleset>
                <role-name>rest-reader</role-name>
              </query-roleset>
              <query-roleset>
                <role-name>my-role</role-name>
              </query-roleset>
            </query-roleset-properties>

This is the payload for POST as XML. The call does not return any content, beyond headers.

Example

> curl -X POST --anyauth -u admin:admin 
        -d @file.json -H "Content-Type:application/json" http://localhost:8002/manage/v2/query-rolesets
    

This is the payload for POST as JSON (as file.json). The call does not return any content, beyond headers.

{"query-rolesets" : { "role":"pii" } }

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.

Comments

The commenting feature on this page is enabled by a third party. Comments posted to this page are publicly visible.
  • This also requires the 'security' role. Without this role, a 403 Forbidden error is returned.