Using REST for Query Rolesets
The following XML and JSON examples show what is returned from GET
(or used as payload to PUT
) when using REST for query rolesets.
This example uses a GET
with the response payload in XML:
$ curl -GET --anyauth -u admin:admin -H "Accept:application/xml,Content-Type:application/xml" http://localhost:8002/manage/v2/security/properties
This returns
<security-properties xmlns="http://marklogic.com/manage"> <query-rolesets> <query-roleset> <role>432432534053458236326</role> <role>454643243253405823326</role> </query-roleset> <query-roleset> <role>124325333458236346123</role> <role>124233432432534058213</role> </query-roleset> </query-rolesets> </security-properties>
Here is the same example with a JSON response payload:
$ curl -GET --anyauth -u admin:admin -H "Accept:application/json,Content-Type:application/json" GET:/manage/v2/security/properties
This returns
{ "queryRoleset": [ [ 432232321212123100000, 432432534053458200000 ], [ 124325333458236346123, 124233432432534058213 ] ] }
Note
The REST Management APIs will accept both role names and role IDs in configuring query rolesets with PUT
.
The following are example payloads for POST
or PUT
calls for managing query rolesets.
JSON:
{ "role-name": ["manage-admin","rest-writer"] }
XML:
<query-roleset-properties xmlns="http://marklogic.com/manage/query-roleset/properties"> <query-roleset> <role-name>rest-reader</role-name> </query-roleset> </query-roleset-properties>