*此内容使用人工智能(Beta)翻译,可能包含错误。若要查看英文页面,请点按 此处

GroupMembership

对群组的会员资格。用户ID可以用作会员ID的替代。

属性

pathstring

群组成员的资源路径。

格式:groups/{group_id}/memberships/{group_membership_id}.

createTimestring
仅输出

群组成员创建时的时戳。. 此字符串格式为 FieldMask

updateTimestring
仅输出

群组成员最后更新时间戳。. 此字符串格式为 FieldMask

userstring
不可改变

群组成员的资源路径。.

rolestring

群组成员的资源路径。.

基本网址

https://apis.roblox.com
GroupMembership 资源

{
"path": "groups/123/memberships/123",
"createTime": "2023-07-05T12:34:56Z",
"updateTime": "2023-07-05T12:34:56Z",
"user": "users/21557",
"role": "groups/7/roles/99513316"
}

GroupMembership

列出群组成员schaft
Beta

GET /cloud/v2/groups/{group_id}/memberships

在群组中列出群组成员。

请求路径参数
group_idstring
必填

群组ID。.

查询参数
maxPageSizenumber

返回的群组成员最大数量。服务可能返回小于此值。如果未指定,最多返回 10 个群组会员。最大值为 100,更高值设置为 100。.

pageTokenstring

从前一次调用收到的页面代币,用于检索后续页面。

当页面分页时,所有其他参数提供给后续调用的必须与提供页面代币的调用匹配。.

filterstring

该字段可以设置以便筛选返回的资源。

请参阅过滤文档获取更多信息。.

答复

父集合中的群组成员列表。

groupMembershipsarray<GroupMembership>

从指定的组中的群组成员。.

nextPageTokenstring

您可以将其作为pageToken参数发送的代币来检索下一页。如果该字段被忽略,就没有后续页面。.

GET /cloud/v2/groups/{group_id}/memberships

curl -L -X GET 'https://apis.roblox.com/cloud/v2/groups/{group_id}/memberships?maxPageSize=10&pageToken={string}&filter={string}' \
-H 'x-api-key: {your-api-key}'
答复

{
"groupMemberships": [
{
"path": "groups/123/memberships/123",
"createTime": "2023-07-05T12:34:56Z",
"updateTime": "2023-07-05T12:34:56Z",
"user": "users/21557",
"role": "groups/7/roles/99513316"
}
],
"nextPageToken": "string"
}

GroupMembership

更新群组成员资格
Beta

PATCH /cloud/v2/groups/{group_id}/memberships/{membership_id}

为特定群组成员更新群组会员资格。此操作需要请求者能够管理低级成员。无法分配游客或所有者等级,也无法更改请求者的自己等级。

范围
group:write
请求路径参数
group_idstring
必填

群组ID。.

membership_idstring
必填

会员ID。.

请求正文GroupMembership
PATCH /cloud/v2/groups/{group_id}/memberships/{membership_id}

curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/groups/{group_id}/memberships/{membership_id}' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"role": "groups/7/roles/99513316"
}'
答复

{
"path": "groups/123/memberships/123",
"createTime": "2023-07-05T12:34:56Z",
"updateTime": "2023-07-05T12:34:56Z",
"user": "users/21557",
"role": "groups/7/roles/99513316"
}