gs.site.member.json

Author:Michael JasonSmith
Contact:Michael JasonSmith <mpj17@onlinegroups.net>
Date:2015-16-17
Organization:GroupServer.org
Copyright:This document is licensed under a Creative Commons Attribution-Share Alike 4.0 International License by OnlineGroups.net.

In GroupServer each group belongs to a site. Likewise, each group-member belongs to a related site-member user-group. This product provides a web hook that provides a list of the site members, in JSON format.

Contents:

Web hook

Synopsis

/gs-site-member-list.json? token =<t> & (users | user_groups)

Description

The web hook gs-site-member-list.json in the site context takes a token and returns a JSON formatted list of all users. What is returned depends on the action, which is either users or user_groups.

Required arguments

token=<token>

The authentication token [1].

The action can be one of two values (no value needs to be set, but the argument must be present):

users

Retrieve a simple list of all the site-members.

user_groups

A complex list of all the site members is returned, along with the groups on the site that each person belongs to.

Returns

A list of people that belong to at least one group on the site.

Example

Retrieving a list of user-identifiers.

$ wget --post-data='token=Fake&users' \
  http://groups.example.com/gs-site-member-list.json

Retrieving a list of profiles for the people that belong to at least one group on the site:

$ wget --post-data='token=Falke&user_groups' \
  http://groups.example.com/gs-site-member-list.json
[1]See gs.auth.token for more information <https://github.com/groupserver/gs.auth.token>

Changelog

1.0.0 (2015-06-19)

Initial version. Prior to the creation of this product there was no way to retrieve a list of site members.

Indices and tables