Was this page helpful?

POST:pages/{pageid}/allowed

    Overview

    public. Filter a list of user ids based on access to the page

    Uri Parameters
    NameTypeDescription
    pageidintinteger page ID
    Query Parameters
    NameTypeDescription
    filterdisabledbool?Consider disabled users to be disallowed, regardless of permissions (default: false)
    permissionsstring?A comma separated list of permissions that must be satisfied (e.g read, etc.). Defaults to read, if not provided
    Return Codes
    NameValueDescription
    BadRequest400Invalid input parameter or request body
    Forbidden403Read access to the page is required
    NotFound404Requested page could not be found
    Ok200The request completed successfully

    Message Format

    Input:

    List of all users to run feature against:

    <users>
    	<user id="{id}"/>
            <user id="{id}"/>        
            ...
    </users>

    Output:

    List of all users with allowed permissions as specified in the query parameter:

    <users>
    	<user id="{id}"/>
            <user id="{id}"/>
            ...
    </users>

    Implementation Notes

    The feature takes in as input a list of users and outputs a filtered user list whose members have a page permission that matches one or more of the permissions given in the query parameter.

    Code Samples

    C# Samples

     

    Curl Samples

     

    PHP Samples

     

    Other Code Samples

     

    Was this page helpful?
    Tag page
    You must login to post a comment.

    Copyright © 2011 MindTouch, Inc. Powered by