GroupCloudService
Open Cloud for groups: a group's own tools read members and the audit log and change ranks, with a group API key.
On this page
Open Cloud for groups: a group's own tools (a Discord bot, a ranking center, a dashboard) read its members and audit log and change ranks, with a group API key (Authorization: Bearer neogk_..., SocialService.CreateGroupApiKey) that has the scope each call needs. Keys never sign in as anyone; rank changes are made, and audited, as the key's creator, and only below the creator's current rank. Every method is a POST with a JSON body; see the overview for the protocol, authentication and errors.
Summary#
| Method | Auth | Description |
|---|---|---|
| ListMembers | None | members.read: the group's members, highest rank first. |
| GetMember | None | members.read: one member (NotFound when they aren't one). |
| SetMemberRank | None | members.rank: moves a member to a rank (below the key creator's own, as SetMemberRank does). |
| ListAuditLog | None | audit.read: the group's audit log, newest first. |
Methods#
ListMembers#
members.read: the group's members, highest rank first.
POST /neo.platform.v1.GroupCloudService/ListMembers
Content-Type: application/jsonAuth: None.
Request: CloudListMembersRequest. Response: CloudListMembersResponse.
GetMember#
members.read: one member (NotFound when they aren't one).
POST /neo.platform.v1.GroupCloudService/GetMember
Content-Type: application/jsonAuth: None.
Request: CloudMemberRef. Response: GroupMember.
SetMemberRank#
members.rank: moves a member to a rank (below the key creator's own, as SetMemberRank does).
POST /neo.platform.v1.GroupCloudService/SetMemberRank
Content-Type: application/jsonAuth: None.
Request: CloudSetRankRequest. Response: GroupMember.
ListAuditLog#
audit.read: the group's audit log, newest first.
POST /neo.platform.v1.GroupCloudService/ListAuditLog
Content-Type: application/jsonAuth: None.
Request: CloudAuditRequest. Response: ListGroupAuditResponse.
Types#
CloudAuditRequest#
| Field | Type | Description |
|---|---|---|
limit | number |
CloudListMembersRequest#
| Field | Type | Description |
|---|---|---|
limit | number | up to 200 (default 100) |
pageToken | string | from the previous answer's next_page_token |
minRank | number | only members of this rank or above (0: everyone) |
CloudListMembersResponse#
| Field | Type | Description |
|---|---|---|
members | array of GroupMember | |
nextPageToken | string |
CloudMemberRef#
| Field | Type | Description |
|---|---|---|
userId | string |
CloudSetRankRequest#
| Field | Type | Description |
|---|---|---|
userId | string | |
rank | number |