Page last modified 16:45, 19 Jan 2010 by melder
MindTouch Community Portal > MindTouch Community Portal > Reference > MindTouch API > PUT:pages/{pageid}/security
Table of contents
- 1. Overview
- 1.1.1.1. Uri Parameters
- 1.1.1.2. Query Parameters
- 1.1.1.3. Return Codes
- 2. Message Format
- 3. Implementation Notes
- 4. Code Samples
- 4.1. C# Samples
- 4.2. Curl Samples
- 4.3. PHP Samples
- 4.4. Other Code Samples
Overview
public. Set page security info
Uri Parameters
| Name | Type | Description |
| pageid | string | either an integer page ID, "home", or "=" followed by a double uri-encoded page title |
Query Parameters
| Name | Type | Description |
| authenticate | bool? | Force authentication for request (default: false) |
| cascade | {none,delta,absolute}? | none: Permissions are not cascaded to child pages; deltas: Changes between given page's security and proposed security cascaded to child nodes; absolute: Proposed security is set on child pages. Default: none |
| redirects | int? | If zero, do not follow page redirects. |
Return Codes
| Name | Value | Description |
| BadRequest | 400 | Invalid input parameter or request body |
| Forbidden | 403 | Change permissions access to the page is required |
| NotFound | 404 | Requested page could not be found |
| Ok | 200 | The request completed successfully |
Message Format
Input:
<security>
<permissions.page>
<restriction>{text}</restriction>
</permissions.page>
<grants>
<grant>
<permissions>
<role>{text}</role>
</permissions>
<user id="{int}"></user>
<date.expires>{date}</date.expires>
</grant>
<grant>
<permissions>
<role>{text}</role>
</permissions>
<group id="{int}"></group>
<date.expires>{date}</date.expires>
</grant>
...
</grants>
</security>
Output:
<security href="{uri}">
<permissions.effective>
<operations mask="{int}">{text}</operations>
</permissions.effective>
<permissions.page>
<operations mask="{int}">{text}</operations>
<restriction>{text}</restriction>
</permissions.page>
<grants>
<grant>
<permissions>
<operations mask="{int}">{text}</operations>
<role id="{int}" href="{uri}">{text}</role>
</permissions>
<user id="{int}" href="{uri}">
<nick>{text}</nick>
<username>{text}</username>
<email>{text}</email>
</user>
<date.expires>{date}</date.expires>
<date.modified>{date}</date.modified>
<user.modifiedby id="{int}" href="{uri}">
<nick>{text}</nick>
<username>{text}</username>
<email>{text}</email>
</user.modifiedby>
</grant>
<grant>
<permissions>
<operations mask="{int}">{text}</operations>
<role id="{int}" href="{uri}">{text}</role>
</permissions>
<group id="{int}" href="{uri}">
<name>{text}</name>
</group>
<date.expires>{date}</date.expires>
<date.modified>{date}</date.modified>
<user.modifiedby id="{int}" href="{uri}">
<nick>{text}</nick>
<username>{text}</username>
<email>{text}</email>
</user.modifiedby>
</grant>
...
</grants>
</security>
Implementation Notes
The permissions.page element sets the page restriction. The grants section replaces all existing grants on the page. Use POST:pages/{pageid}/security to add or remove particular grants.
Currently defined page restrictions are:
- Public: All users can read and edit
- Semi-Public: All users can read, but only selected users can edit
- Private: Only selected users can read and edit
Use GET:site/roles to retrieve a list of roles currently defined for the site.
Code Samples
C# Samples
Curl Samples
PHP Samples
Other Code Samples
- Was this page helpful?
- Tag page
- What links here
| Images 0 | ||
|---|---|---|
| No images to display in the gallery. |
You must login to post a comment.
Copyright © 2011 MindTouch, Inc. Powered by