ExilProductions/VRChatBackendDocs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
aa707d1deb9b3d436e6dab60d6d4eeb1406c0478
VRChatBackendDocs/Apis/GroupsApi.md
ExilProductions aa707d1deb add subdir
2026-02-15 17:39:26 +01:00

1504 lines
43 KiB
Markdown
Raw Blame History

# GroupsApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**addGroupGalleryImage**](GroupsApi.md#addGroupGalleryImage) | **POST** /groups/{groupId}/galleries/{groupGalleryId}/images | Add Group Gallery Image |
| [**addGroupMemberRole**](GroupsApi.md#addGroupMemberRole) | **PUT** /groups/{groupId}/members/{userId}/roles/{groupRoleId} | Add Role to GroupMember |
| [**addGroupPost**](GroupsApi.md#addGroupPost) | **POST** /groups/{groupId}/posts | Create a post in a Group |
| [**banGroupMember**](GroupsApi.md#banGroupMember) | **POST** /groups/{groupId}/bans | Ban Group Member |
| [**blockGroup**](GroupsApi.md#blockGroup) | **POST** /groups/{groupId}/block | Block Group |
| [**cancelGroupRequest**](GroupsApi.md#cancelGroupRequest) | **DELETE** /groups/{groupId}/requests | Cancel Group Join Request |
| [**cancelGroupTransfer**](GroupsApi.md#cancelGroupTransfer) | **DELETE** /groups/{groupId}/transfer | Cancel Group Transfer |
| [**createGroup**](GroupsApi.md#createGroup) | **POST** /groups | Create Group |
| [**createGroupAnnouncement**](GroupsApi.md#createGroupAnnouncement) | **POST** /groups/{groupId}/announcement | Create Group Announcement |
| [**createGroupGallery**](GroupsApi.md#createGroupGallery) | **POST** /groups/{groupId}/galleries | Create Group Gallery |
| [**createGroupInvite**](GroupsApi.md#createGroupInvite) | **POST** /groups/{groupId}/invites | Invite User to Group |
| [**createGroupRole**](GroupsApi.md#createGroupRole) | **POST** /groups/{groupId}/roles | Create GroupRole |
| [**declineGroupInvite**](GroupsApi.md#declineGroupInvite) | **PUT** /groups/{groupId}/invites | Decline Invite from Group |
| [**deleteGroup**](GroupsApi.md#deleteGroup) | **DELETE** /groups/{groupId} | Delete Group |
| [**deleteGroupAnnouncement**](GroupsApi.md#deleteGroupAnnouncement) | **DELETE** /groups/{groupId}/announcement | Delete Group Announcement |
| [**deleteGroupGallery**](GroupsApi.md#deleteGroupGallery) | **DELETE** /groups/{groupId}/galleries/{groupGalleryId} | Delete Group Gallery |
| [**deleteGroupGalleryImage**](GroupsApi.md#deleteGroupGalleryImage) | **DELETE** /groups/{groupId}/galleries/{groupGalleryId}/images/{groupGalleryImageId} | Delete Group Gallery Image |
| [**deleteGroupInvite**](GroupsApi.md#deleteGroupInvite) | **DELETE** /groups/{groupId}/invites/{userId} | Delete User Invite |
| [**deleteGroupPost**](GroupsApi.md#deleteGroupPost) | **DELETE** /groups/{groupId}/posts/{notificationId} | Delete a Group post |
| [**deleteGroupRole**](GroupsApi.md#deleteGroupRole) | **DELETE** /groups/{groupId}/roles/{groupRoleId} | Delete Group Role |
| [**getGroup**](GroupsApi.md#getGroup) | **GET** /groups/{groupId} | Get Group by ID |
| [**getGroupAnnouncements**](GroupsApi.md#getGroupAnnouncements) | **GET** /groups/{groupId}/announcement | Get Group Announcement |
| [**getGroupAuditLogEntryTypes**](GroupsApi.md#getGroupAuditLogEntryTypes) | **GET** /groups/{groupId}/auditLogTypes | Get Group Audit Log Entry Types |
| [**getGroupAuditLogs**](GroupsApi.md#getGroupAuditLogs) | **GET** /groups/{groupId}/auditLogs | Get Group Audit Logs |
| [**getGroupBans**](GroupsApi.md#getGroupBans) | **GET** /groups/{groupId}/bans | Get Group Bans |
| [**getGroupGalleryImages**](GroupsApi.md#getGroupGalleryImages) | **GET** /groups/{groupId}/galleries/{groupGalleryId} | Get Group Gallery Images |
| [**getGroupInstances**](GroupsApi.md#getGroupInstances) | **GET** /groups/{groupId}/instances | Get Group Instances |
| [**getGroupInvites**](GroupsApi.md#getGroupInvites) | **GET** /groups/{groupId}/invites | Get Group Invites Sent |
| [**getGroupMember**](GroupsApi.md#getGroupMember) | **GET** /groups/{groupId}/members/{userId} | Get Group Member |
| [**getGroupMembers**](GroupsApi.md#getGroupMembers) | **GET** /groups/{groupId}/members | List Group Members |
| [**getGroupPermissions**](GroupsApi.md#getGroupPermissions) | **GET** /groups/{groupId}/permissions | List Group Permissions |
| [**getGroupPosts**](GroupsApi.md#getGroupPosts) | **GET** /groups/{groupId}/posts | Get posts from a Group |
| [**getGroupRequests**](GroupsApi.md#getGroupRequests) | **GET** /groups/{groupId}/requests | Get Group Join Requests |
| [**getGroupRoleTemplates**](GroupsApi.md#getGroupRoleTemplates) | **GET** /groups/roleTemplates | Get Group Role Templates |
| [**getGroupRoles**](GroupsApi.md#getGroupRoles) | **GET** /groups/{groupId}/roles | Get Group Roles |
| [**getGroupTransferability**](GroupsApi.md#getGroupTransferability) | **GET** /groups/{groupId}/transfer | Get Group Transferability |
| [**initiateOrAcceptGroupTransfer**](GroupsApi.md#initiateOrAcceptGroupTransfer) | **POST** /groups/{groupId}/transfer | Initiate or Accept Group Transfer |
| [**joinGroup**](GroupsApi.md#joinGroup) | **POST** /groups/{groupId}/join | Join Group |
| [**kickGroupMember**](GroupsApi.md#kickGroupMember) | **DELETE** /groups/{groupId}/members/{userId} | Kick Group Member |
| [**leaveGroup**](GroupsApi.md#leaveGroup) | **POST** /groups/{groupId}/leave | Leave Group |
| [**removeGroupMemberRole**](GroupsApi.md#removeGroupMemberRole) | **DELETE** /groups/{groupId}/members/{userId}/roles/{groupRoleId} | Remove Role from GroupMember |
| [**respondGroupJoinRequest**](GroupsApi.md#respondGroupJoinRequest) | **PUT** /groups/{groupId}/requests/{userId} | Respond Group Join request |
| [**searchGroupMembers**](GroupsApi.md#searchGroupMembers) | **GET** /groups/{groupId}/members/search | Search Group Members |
| [**searchGroups**](GroupsApi.md#searchGroups) | **GET** /groups | Search Group |
| [**unbanGroupMember**](GroupsApi.md#unbanGroupMember) | **DELETE** /groups/{groupId}/bans/{userId} | Unban Group Member |
| [**updateGroup**](GroupsApi.md#updateGroup) | **PUT** /groups/{groupId} | Update Group |
| [**updateGroupGallery**](GroupsApi.md#updateGroupGallery) | **PUT** /groups/{groupId}/galleries/{groupGalleryId} | Update Group Gallery |
| [**updateGroupMember**](GroupsApi.md#updateGroupMember) | **PUT** /groups/{groupId}/members/{userId} | Update Group Member |
| [**updateGroupPost**](GroupsApi.md#updateGroupPost) | **PUT** /groups/{groupId}/posts/{notificationId} | Edits a Group post |
| [**updateGroupRepresentation**](GroupsApi.md#updateGroupRepresentation) | **PUT** /groups/{groupId}/representation | Update Group Representation |
| [**updateGroupRole**](GroupsApi.md#updateGroupRole) | **PUT** /groups/{groupId}/roles/{groupRoleId} | Update Group Role |
<a name="addGroupGalleryImage"></a>
# **addGroupGalleryImage**
> GroupGalleryImage addGroupGalleryImage(groupId, groupGalleryId, AddGroupGalleryImageRequest)
Add Group Gallery Image
Adds an image to a Group gallery.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **groupGalleryId** | **String**| Must be a valid group gallery ID. | [default to null] |
| **AddGroupGalleryImageRequest** | [**AddGroupGalleryImageRequest**](../Models/AddGroupGalleryImageRequest.md)| | |
### Return type
[**GroupGalleryImage**](../Models/GroupGalleryImage.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="addGroupMemberRole"></a>
# **addGroupMemberRole**
> List addGroupMemberRole(groupId, userId, groupRoleId)
Add Role to GroupMember
Adds a Role to a Group Member
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **groupRoleId** | **String**| Must be a valid group role ID. | [default to null] |
### Return type
**List**
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="addGroupPost"></a>
# **addGroupPost**
> GroupPost addGroupPost(groupId, CreateGroupPostRequest)
Create a post in a Group
Create a post in a Group.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **CreateGroupPostRequest** | [**CreateGroupPostRequest**](../Models/CreateGroupPostRequest.md)| | |
### Return type
[**GroupPost**](../Models/GroupPost.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="banGroupMember"></a>
# **banGroupMember**
> GroupMember banGroupMember(groupId, BanGroupMemberRequest)
Ban Group Member
Bans a user from a Group.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **BanGroupMemberRequest** | [**BanGroupMemberRequest**](../Models/BanGroupMemberRequest.md)| | |
### Return type
[**GroupMember**](../Models/GroupMember.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="blockGroup"></a>
# **blockGroup**
> Success blockGroup(groupId)
Block Group
Blocks a Group for the current user. To unblock a group, call kickGroupMember (DELETE /groups/{groupId}/members/{userId}).
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="cancelGroupRequest"></a>
# **cancelGroupRequest**
> cancelGroupRequest(groupId)
Cancel Group Join Request
Cancels a request sent to join the group.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="cancelGroupTransfer"></a>
# **cancelGroupTransfer**
> Success cancelGroupTransfer(groupId)
Cancel Group Transfer
Cancel a Group Transfer.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="createGroup"></a>
# **createGroup**
> Group createGroup(CreateGroupRequest)
Create Group
Creates a Group and returns a Group object. **Requires VRC+ Subscription.**
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **CreateGroupRequest** | [**CreateGroupRequest**](../Models/CreateGroupRequest.md)| | |
### Return type
[**Group**](../Models/Group.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="createGroupAnnouncement"></a>
# **createGroupAnnouncement**
> GroupAnnouncement createGroupAnnouncement(groupId, CreateGroupAnnouncementRequest)
Create Group Announcement
Creates an Announcement for a Group. Warning: This will also remove all announcements. To make proper announcements, use the posts endpoint instead
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **CreateGroupAnnouncementRequest** | [**CreateGroupAnnouncementRequest**](../Models/CreateGroupAnnouncementRequest.md)| | |
### Return type
[**GroupAnnouncement**](../Models/GroupAnnouncement.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="createGroupGallery"></a>
# **createGroupGallery**
> GroupGallery createGroupGallery(groupId, CreateGroupGalleryRequest)
Create Group Gallery
Creates a gallery for a Group.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **CreateGroupGalleryRequest** | [**CreateGroupGalleryRequest**](../Models/CreateGroupGalleryRequest.md)| | |
### Return type
[**GroupGallery**](../Models/GroupGallery.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="createGroupInvite"></a>
# **createGroupInvite**
> createGroupInvite(groupId, CreateGroupInviteRequest)
Invite User to Group
Sends an invite to a user to join the group.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **CreateGroupInviteRequest** | [**CreateGroupInviteRequest**](../Models/CreateGroupInviteRequest.md)| | |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="createGroupRole"></a>
# **createGroupRole**
> GroupRole createGroupRole(groupId, CreateGroupRequest\_1)
Create GroupRole
Create a Group role.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **CreateGroupRequest\_1** | [**CreateGroupRequest_1**](../Models/CreateGroupRequest_1.md)| | |
### Return type
[**GroupRole**](../Models/GroupRole.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="declineGroupInvite"></a>
# **declineGroupInvite**
> Success declineGroupInvite(groupId, DeclineGroupInviteRequest)
Decline Invite from Group
Declines an invite to the user from a group.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **DeclineGroupInviteRequest** | [**DeclineGroupInviteRequest**](../Models/DeclineGroupInviteRequest.md)| | [optional] |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="deleteGroup"></a>
# **deleteGroup**
> Success deleteGroup(groupId, hardDelete)
Delete Group
Deletes a Group.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **hardDelete** | **Boolean**| | [optional] [default to null] |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteGroupAnnouncement"></a>
# **deleteGroupAnnouncement**
> Success deleteGroupAnnouncement(groupId)
Delete Group Announcement
Deletes the announcement for a Group.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteGroupGallery"></a>
# **deleteGroupGallery**
> Success deleteGroupGallery(groupId, groupGalleryId)
Delete Group Gallery
Deletes a gallery for a Group.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **groupGalleryId** | **String**| Must be a valid group gallery ID. | [default to null] |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteGroupGalleryImage"></a>
# **deleteGroupGalleryImage**
> Success deleteGroupGalleryImage(groupId, groupGalleryId, groupGalleryImageId)
Delete Group Gallery Image
Deletes an image from a Group gallery.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **groupGalleryId** | **String**| Must be a valid group gallery ID. | [default to null] |
| **groupGalleryImageId** | **String**| Must be a valid group gallery image ID. | [default to null] |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteGroupInvite"></a>
# **deleteGroupInvite**
> deleteGroupInvite(groupId, userId)
Delete User Invite
Deletes an Group invite sent to a User
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteGroupPost"></a>
# **deleteGroupPost**
> Success deleteGroupPost(groupId, notificationId)
Delete a Group post
Delete a Group post
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteGroupRole"></a>
# **deleteGroupRole**
> List deleteGroupRole(groupId, groupRoleId)
Delete Group Role
Deletes a Group Role by ID and returns the remaining roles.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **groupRoleId** | **String**| Must be a valid group role ID. | [default to null] |
### Return type
[**List**](../Models/GroupRole.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroup"></a>
# **getGroup**
> Group getGroup(groupId, includeRoles)
Get Group by ID
Returns a single Group by ID.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **includeRoles** | **Boolean**| Include roles for the Group object. Defaults to false. | [optional] [default to null] |
### Return type
[**Group**](../Models/Group.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupAnnouncements"></a>
# **getGroupAnnouncements**
> GroupAnnouncement getGroupAnnouncements(groupId)
Get Group Announcement
Returns the announcement for a Group. If no announcement has been made, then it returns **empty object**. If an announcement exists, then it will always return all fields except &#x60;imageId&#x60; and &#x60;imageUrl&#x60; which may be null.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
### Return type
[**GroupAnnouncement**](../Models/GroupAnnouncement.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupAuditLogEntryTypes"></a>
# **getGroupAuditLogEntryTypes**
> List getGroupAuditLogEntryTypes(groupId)
Get Group Audit Log Entry Types
Returns a list of audit log entry types for which the group has entries.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
### Return type
**List**
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupAuditLogs"></a>
# **getGroupAuditLogs**
> PaginatedGroupAuditLogEntryList getGroupAuditLogs(groupId, n, offset, startDate, endDate, actorIds, eventTypes, targetIds)
Get Group Audit Logs
Returns a list of audit logs for a Group.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **startDate** | **Date**| The start date of the search range. | [optional] [default to null] |
| **endDate** | **Date**| The end date of the search range. | [optional] [default to null] |
| **actorIds** | **String**| The comma-separated actor ids to search for. | [optional] [default to null] |
| **eventTypes** | **String**| The comma-separated event types to search for. | [optional] [default to null] |
| **targetIds** | **String**| The comma-separated target ids to search for. | [optional] [default to null] |
### Return type
[**PaginatedGroupAuditLogEntryList**](../Models/PaginatedGroupAuditLogEntryList.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupBans"></a>
# **getGroupBans**
> List getGroupBans(groupId, n, offset)
Get Group Bans
Returns a list of banned users for a Group.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**List**](../Models/GroupMember.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupGalleryImages"></a>
# **getGroupGalleryImages**
> List getGroupGalleryImages(groupId, groupGalleryId, n, offset, approved)
Get Group Gallery Images
Returns a list of images for a Group gallery.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **groupGalleryId** | **String**| Must be a valid group gallery ID. | [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **approved** | **Boolean**| If specified, only returns images that have been approved or not approved. | [optional] [default to null] |
### Return type
[**List**](../Models/GroupGalleryImage.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupInstances"></a>
# **getGroupInstances**
> List getGroupInstances(groupId)
Get Group Instances
Returns a list of group instances
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
### Return type
[**List**](../Models/GroupInstance.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupInvites"></a>
# **getGroupInvites**
> List getGroupInvites(groupId, n, offset)
Get Group Invites Sent
Returns a list of members that have been invited to the Group.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**List**](../Models/GroupMember.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupMember"></a>
# **getGroupMember**
> GroupMember getGroupMember(groupId, userId)
Get Group Member
Returns a GroupMember.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**GroupMember**](../Models/GroupMember.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupMembers"></a>
# **getGroupMembers**
> List getGroupMembers(groupId, n, offset, sort, roleId)
List Group Members
Returns a List of all **other** Group Members. This endpoint will never return the user calling the endpoint. Information about the user calling the endpoint must be found in the &#x60;myMember&#x60; field of the Group object.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **sort** | **String**| The sort order of Group Member results | [optional] [default to null] [enum: joinedAt:asc, joinedAt:desc] |
| **roleId** | **String**| Only returns members with a specific groupRoleId | [optional] [default to null] |
### Return type
[**List**](../Models/GroupMember.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupPermissions"></a>
# **getGroupPermissions**
> List getGroupPermissions(groupId)
List Group Permissions
Returns a List of all possible/available permissions for a Group.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
### Return type
[**List**](../Models/GroupPermission.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupPosts"></a>
# **getGroupPosts**
> getGroupPosts_200_response getGroupPosts(groupId, n, offset, publicOnly)
Get posts from a Group
Get posts from a Group
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **publicOnly** | **Boolean**| See public posts only. | [optional] [default to null] |
### Return type
[**getGroupPosts_200_response**](../Models/getGroupPosts_200_response.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupRequests"></a>
# **getGroupRequests**
> List getGroupRequests(groupId, n, offset, blocked)
Get Group Join Requests
Returns a list of members that have requested to join the Group.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **blocked** | **Boolean**| See blocked join requests | [optional] [default to null] |
### Return type
[**List**](../Models/GroupMember.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupRoleTemplates"></a>
# **getGroupRoleTemplates**
> Map getGroupRoleTemplates()
Get Group Role Templates
Obtain predefined templates for group roles
### Parameters
This endpoint does not need any parameter.
### Return type
[**Map**](../Models/GroupRoleTemplateValues.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupRoles"></a>
# **getGroupRoles**
> List getGroupRoles(groupId)
Get Group Roles
Returns a Group Role by ID.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
### Return type
[**List**](../Models/GroupRole.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getGroupTransferability"></a>
# **getGroupTransferability**
> GroupTransferable getGroupTransferability(groupId, transferTargetId)
Get Group Transferability
Returns the transferability of the group to a given user.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **transferTargetId** | **String**| The UserID of the prospective transferee. | [optional] [default to null] |
### Return type
[**GroupTransferable**](../Models/GroupTransferable.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="initiateOrAcceptGroupTransfer"></a>
# **initiateOrAcceptGroupTransfer**
> Success initiateOrAcceptGroupTransfer(groupId, TransferGroupRequest)
Initiate or Accept Group Transfer
To initiate, must be logged in as the current owner and specify the transferTargetId in the body. To accept, must be logged in as the user targetted by a pending transfer, no body is required.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **TransferGroupRequest** | [**TransferGroupRequest**](../Models/TransferGroupRequest.md)| | [optional] |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="joinGroup"></a>
# **joinGroup**
> GroupMember joinGroup(groupId, confirmOverrideBlock, JoinGroupRequest)
Join Group
Join a Group by ID and returns the member object.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **confirmOverrideBlock** | **Boolean**| Manually override the failure that would occur if the user has blocked the group. | [optional] [default to null] |
| **JoinGroupRequest** | [**JoinGroupRequest**](../Models/JoinGroupRequest.md)| | [optional] |
### Return type
[**GroupMember**](../Models/GroupMember.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="kickGroupMember"></a>
# **kickGroupMember**
> Success kickGroupMember(groupId, userId)
Kick Group Member
Kicks a Group Member from the Group. The current user must have the \&quot;Remove Group Members\&quot; permission. Also used for unblocking groups.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="leaveGroup"></a>
# **leaveGroup**
> leaveGroup(groupId)
Leave Group
Leave a group by ID.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="removeGroupMemberRole"></a>
# **removeGroupMemberRole**
> List removeGroupMemberRole(groupId, userId, groupRoleId)
Remove Role from GroupMember
Removes a Role from a Group Member
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **groupRoleId** | **String**| Must be a valid group role ID. | [default to null] |
### Return type
**List**
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="respondGroupJoinRequest"></a>
# **respondGroupJoinRequest**
> respondGroupJoinRequest(groupId, userId, RespondGroupJoinRequest)
Respond Group Join request
Responds to a Group Join Request with Accept/Deny
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **RespondGroupJoinRequest** | [**RespondGroupJoinRequest**](../Models/RespondGroupJoinRequest.md)| | |
### Return type
null (empty response body)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="searchGroupMembers"></a>
# **searchGroupMembers**
> searchGroupMembers_200_response searchGroupMembers(groupId, query, n, offset)
Search Group Members
Search for members in the group by displayName.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **query** | **String**| Filter for member displayName. | [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
### Return type
[**searchGroupMembers_200_response**](../Models/searchGroupMembers_200_response.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="searchGroups"></a>
# **searchGroups**
> List searchGroups(query, offset, n)
Search Group
Searches Groups by name or shortCode
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **query** | **String**| Query to search for, can be either Group Name or Group shortCode | [optional] [default to null] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
### Return type
[**List**](../Models/LimitedGroup.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="unbanGroupMember"></a>
# **unbanGroupMember**
> GroupMember unbanGroupMember(groupId, userId)
Unban Group Member
Unbans a user from a Group.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **userId** | **String**| Must be a valid user ID. | [default to null] |
### Return type
[**GroupMember**](../Models/GroupMember.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="updateGroup"></a>
# **updateGroup**
> Group updateGroup(groupId, UpdateGroupRequest)
Update Group
Updates a Group and returns it.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **UpdateGroupRequest** | [**UpdateGroupRequest**](../Models/UpdateGroupRequest.md)| | [optional] |
### Return type
[**Group**](../Models/Group.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="updateGroupGallery"></a>
# **updateGroupGallery**
> GroupGallery updateGroupGallery(groupId, groupGalleryId, UpdateGroupGalleryRequest)
Update Group Gallery
Updates a gallery for a Group.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **groupGalleryId** | **String**| Must be a valid group gallery ID. | [default to null] |
| **UpdateGroupGalleryRequest** | [**UpdateGroupGalleryRequest**](../Models/UpdateGroupGalleryRequest.md)| | [optional] |
### Return type
[**GroupGallery**](../Models/GroupGallery.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="updateGroupMember"></a>
# **updateGroupMember**
> GroupMember updateGroupMember(groupId, userId, UpdateGroupMemberRequest)
Update Group Member
Updates a Group Member
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **UpdateGroupMemberRequest** | [**UpdateGroupMemberRequest**](../Models/UpdateGroupMemberRequest.md)| | [optional] |
### Return type
[**GroupMember**](../Models/GroupMember.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="updateGroupPost"></a>
# **updateGroupPost**
> GroupPost updateGroupPost(groupId, notificationId, CreateGroupPostRequest)
Edits a Group post
Edits a Group post
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **notificationId** | **String**| Must be a valid notification ID. | [default to null] |
| **CreateGroupPostRequest** | [**CreateGroupPostRequest**](../Models/CreateGroupPostRequest.md)| | |
### Return type
[**GroupPost**](../Models/GroupPost.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="updateGroupRepresentation"></a>
# **updateGroupRepresentation**
> Success updateGroupRepresentation(groupId, updateGroupRepresentation\_request)
Update Group Representation
Updates whether the user is representing the group. When &#x60;isRepresenting&#x60; is set to &#x60;true&#x60;, this flag will be set to &#x60;false&#x60; for all other groups
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **updateGroupRepresentation\_request** | [**updateGroupRepresentation_request**](../Models/updateGroupRepresentation_request.md)| | |
### Return type
[**Success**](../Models/Success.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="updateGroupRole"></a>
# **updateGroupRole**
> List updateGroupRole(groupId, groupRoleId, UpdateGroupRoleRequest)
Update Group Role
Updates a group role by ID.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **groupId** | **String**| Must be a valid group ID. | [default to null] |
| **groupRoleId** | **String**| Must be a valid group role ID. | [default to null] |
| **UpdateGroupRoleRequest** | [**UpdateGroupRoleRequest**](../Models/UpdateGroupRoleRequest.md)| | [optional] |
### Return type
[**List**](../Models/GroupRole.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
Reference in New Issue View Git Blame Copy Permalink