GET:groups/{groupid}

Overview

public. Retrieve group information

Message Format

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

Groups provide the ability to associate a collection of users with a predefined role.  Use GET:site/roles to retrieve a list of all roles currently defined on the site.

Use GET:groups to retrieve a list of groups defined across the site.

Code Samples

The following code example retrieves the group called "My Contributors Group":

Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
p.At("groups", "=My%2520Contributors%2520Group").Get();

Sample response indicating that the group is associated with the local authentication service, contains one user, and has the Contributor role:

<group id="1" href="http://deki-hayes/@api/deki/groups/1">
    <groupname>My Contributors Group</groupname> 
    <service.authentication id="1" href="http://deki-hayes/@api/deki/site/services/1" /> 
    <users count="1" href="http://deki-hayes/@api/deki/groups/1/users" /> 
    <permissions.group>
        <operations mask="1343">LOGIN,BROWSE,READ,SUBSCRIBE,UPDATE,CREATE,DELETE,CHANGEPERMISSIONS</operations> 
        <role id="4" href="http://deki-hayes/@api/deki/site/roles/4">Contributor</role> 
    </permissions.group>
</group>