Member

Manage the relationship between Users and Groups. Members are accessed via /api/member.

Properties

See "Object Properties" in Introduction for basic shared properties.

Complete details in MemberProperties.

Related Objects

See "Related Objects" in Introduction for how to use them.

group

The Group that controls member.

user

The User that controls member.

Services

The services used to fetch and manipulate members.

Search Members

Searching across all groups is no longer supported. To search on a single group see "Relationships" in Group.

Create Member

Deprecated endpoint. Instead use "join" in Group or "add-member" in Group as appropriate.

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

Required Params

group_id

user_id

Returns the same as a normal read.

Read Member

 GET /api/member/xxx

Returns:

 {
   "id" : "xxx",
   "user_id" : "xxx",
   ...
 }

Update Member

 PUT /api/member/xxx

Returns the same as a normal read.

Delete Member

 DELETE /api/member/xxx

Returns:

 {
   "success" : 1
 }

Promote Member to Leader

Only the group leader can promote another member to leader.

 POST /api/member/xxx/promote/leader

There is no corresponding /demote/leader endpoint, because a Group must always have a leader, so a leader can only be replaced.

Returns the same as a normal read.

Promote Member to Director

Only the group leader or a group director can promote another member to director.

 POST /api/member/xxx/promote/director

Returns the same as a normal read.

Demote Member from Director

Only the group leader or a group director can demote another director.

 POST /api/member/xxx/demote/director

Returns the same as a normal read.