Introduction

The Members API provides functionality for managing group members, inluding adding, removing, and querying group members.

Settings for Typical Use Case

• If a group's privacy level is set to SECRET, group admins or group members can add additional members to their group.
• If a group's privacy level is set to PUBLIC or PRIVATE, group admins determine whether group members can add additional members to their group.
• This setting can be found in your site's Dashboard under Groups Application > Your Group > Admin Tools > Member Permissions.
• If set to all members, group members can add additional members to the group using the addGroupMembers() function (no approval required).
• If set to admins only, only admins can add additional members to the group using the addGroupMembers() function.
• The default is set to admins only.
• Note: If the suppressAuth option is set to true, all permissions are overwritten and all site members (including non-group members) can add additional members to a group.

The Members API provides functionality allowing you to:

• Add members to a group.
• List all members of a group.
• List a site member's group memberships.
• Query members of a group.
• Query a site member's group memberships.
• Remove members of a group.

Permissions Information