GET:groups/{groupid}/users

Overview

public. Return a list of users in a group

Message Format

Output:

<users count="{int}" href="{uri}">
    <user id="{int}" href="{uri}">
        <nick>{text}</nick> 
        <username>{text}</username> 
        <email>{text}</email> 
    </user>
    ...
</users>

Implementation Notes

Groups provide the ability to associate a collection of users with a predefined role.

Code Samples

The following code example retrieves the users in the group with ID 1:

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

Sample response indicating that the group contains the user "user1":

<users count="1" href="http://deki-hayes/@api/deki/groups/1/users">
    <user id="3" href="http://deki-hayes/@api/deki/users/3">
        <nick>user1</nick> 
        <username>user1</username> 
        <email>user1@mindtouch.com</email> 
    </user>
</users>