Manage the relationship between Users and Groups.
Members are accessed via /api/member
.
See "Object Properties" in Introduction for basic shared properties.
Complete details in MemberProperties.
See "Related Objects" in Introduction for how to use them.
The Group that controls member.
The User that controls member.
The services used to fetch and manipulate members.
This will search across all groups. To search on a single group see "Relationships" in Group.
GET /api/member
Returns:
{ "paging" : {...}, "items" : [ { "id" : "xxx", "user_id" : "xxx", ... }, ... ] }
If the group's enrollment
is open
you can join it yourself. If it is apply
then you must create a PendingMember instead. And if it is invite
then you must be invited to join the group.
POST /api/member
Returns the same as a normal read.
GET /api/member/xxx
Returns:
{ "id" : "xxx", "user_id" : "xxx", ... }
PUT /api/member/xxx
Returns the same as a normal read.
DELETE /api/member/xxx
Returns:
{ "success" : 1 }
Only group leaders can make promotions.
POST /api/member/xxx/promote
Current valid options are director
.
Only group leaders can make demotions.
POST /api/member/xxx/promote
Current valid options are director
.