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¶
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.
- If the action was
users
then a simple list of user-identifiers is returned. - If the
user_groups
then a list of standard user-objects will be returned (see the core web-hook documentation).
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> |