Was this page helpful?

POST:groups

    Overview

    public. Add or modify a group

    Uri Parameters

    None

    Query Parameters
    NameTypeDescription
    authenticatebool?Force authentication for request (default: false)
    authpasswordstring?Password to use for verification with external authentication service
    authusernamestring?Username to use for verification with external authentication service
    Return Codes
    NameValueDescription
    BadRequest400Invalid input parameter or request body
    Conflict409Group already exists
    Forbidden403Administrator access is required
    NotFound404Requested group could not be found
    Ok200Request completed successfully

    Message Format

    Input:

    <group id="{int}">
        <name>{text}</name>
        <service.authentication id="{int}" />
        <users>
            <user id="{int}"/>
            ...
        </users>
        <permissions.group>
            <role>{text}</role>
        </permissions.group>
    </group>

    Output :

    <group id="{int}" href="{uri}">  
        <name>{text}</name>   
        <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

    If group ID is unspecified, a new group will be created.  If group ID is specified, the role of the existing group will be updated.

    If service.authentication is unspecified, the local authentication service is assumed.  Otherwise, if an external authentication service is used, the authpassword and authusername query parameters will be used to login.

    The role name must match one of the roles defined by GET:site/roles.

    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