Was this page helpful?

PUT:groups/{groupid}/users

    Overview

    public. Set the members for a group

    Uri Parameters
    NameTypeDescription
    groupidstringeither an integer group ID or "=" followed by a double uri-encoded group name
    Query Parameters
    NameTypeDescription
    authenticatebool?Force authentication for request (default: false)
    Return Codes
    NameValueDescription
    BadRequest400Invalid input parameter or request body
    Forbidden403Administrator access is required
    NotFound404Requested group could not be found
    Ok200Request completed successfully

    Message Format

    Input:

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

    Output:

    <group id="{int}" href="{uri}">  
        <groupname>{text}</groupname>   
        <service.authentication id="{int}" href="{uri}" />   
        <users count="{int}" href="{uri}" />   
        <permissions.group>  
             <operations mask="{int}">{text}</operations>   
             <role id="{int}" href="{uri}">{text}</role>   
        </permissions.group>  
    </group>

    Implementation Notes

    Note that this feature only updates the group user list.  Additionally, the list of users passed does not append to the existing set, but replaces that set completely.

    Use PUT:groups/{groupid} to modify the group role. 

    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