---
url: /apidocs/group.md
---
## Group API

| Endpoint | Method | Description |
|-----|-----|-----|
| [group:createGroup](#create-group) | websocket | Create group |
| [group:deleteGroup](#delete-group) | websocket | Delete group |
| [group:updateGroup](#update-group) | websocket | Update group |
| [group:getGroup](#get-group) | websocket | Get group |
| [group:getGroupMember](#get-group-member) | websocket | Get group member |
| [group:joinGroup](#join-group) | websocket | Join group |
| [group:addGroupMembers](#add-group-members) | websocket | Add group members |
| [group:deleteGroupMembers](#delete-group-members) | websocket | Delete group members |
| [group:updateMemberRole](#update-member-role) | websocket | Update member role |
| [group:searchUserGroups](#search-user-groups) | websocket | Search user groups |
| [group:searchGroupMembers](#search-group-members) | websocket | Search group members |
| [group:discoverGroups](#discover-groups-by-cbac) | websocket | Discover groups by cbac |
| [group:onGroupCreated](#on-group-created-event) | websocketEvent | On group created event |
| [group:onGroupDeleted](#on-group-deleted-event) | websocketEvent | On group deleted event |
| [group:onGroupUpdated](#on-group-updated-event) | websocketEvent | On group updated event |
| [group:onGroupMembersAdded](#on-group-members-added-event) | websocketEvent | On group members added event |
| [group:onGroupMembersDeleted](#on-group-members-deleted-event) | websocketEvent | On group members deleted event |
| [group:onGroupMemberUpdated](#on-group-member-updated-event) | websocketEvent | On group member updated event |

### Create group

**Method:** websocket

**Endpoint:** group:createGroup

**Request:**

**Response:**

### Delete group

**Method:** websocket

**Endpoint:** group:deleteGroup

**Request:**

**Response:**

### Update group

**Method:** websocket

**Endpoint:** group:updateGroup

**Request:**

**Response:**

### Get group

**Method:** websocket

**Endpoint:** group:getGroup

**Request:**

**Response:**

### Get group member

**Method:** websocket

**Endpoint:** group:getGroupMember

**Description:** Returns a single group member's role and join time. The calling user must have view access to the group.

**Request:**

**Response:**

### Join group

**Method:** websocket

**Endpoint:** group:joinGroup

**Description:** Joins the calling user to the specified group via CBAC. The user must hold a badge that satisfies CBAC policy on the target group.

**Request:**

**Response:**

### Add group members

**Method:** websocket

**Endpoint:** group:addGroupMembers

**Request:**

**Response:**

### Delete group members

**Method:** websocket

**Endpoint:** group:deleteGroupMembers

**Request:**

**Response:**

### Update member role

**Method:** websocket

**Endpoint:** group:updateMemberRole

**Request:**

**Response:**

### Search user groups

**Method:** websocket

**Endpoint:** group:searchUserGroups

**Request:**

**Response:**

### Search group members

**Method:** websocket

**Endpoint:** group:searchGroupMembers

**Request:**

**Response:**

### Discover groups by cbac

**Method:** websocket

**Endpoint:** group:discoverGroups

**Description:** Returns groups that the caller can join via CBAC. Lists the caller's badges, finds all group targets reachable by those badges, and returns the matching group models with cbacPolicies populated.

**Request:**

**Response:**

### On group created event

**Event:** group:onGroupCreated

**Data:**

### On group deleted event

**Event:** group:onGroupDeleted

**Data:**

### On group updated event

**Event:** group:onGroupUpdated

**Data:**

### On group members added event

**Event:** group:onGroupMembersAdded

**Data:**

### On group members deleted event

**Event:** group:onGroupMembersDeleted

**Data:**

### On group member updated event

**Event:** group:onGroupMemberUpdated

**Data:**

## Models

#### User Simple