*此內容是使用 AI(Beta 測試版)翻譯,可能含有錯誤。若要以英文檢視此頁面,請按一下這裡

GroupMembership

對群組的會員資格。使用者ID可以用於會員ID的位置。

特性

pathstring

群組會員資源路徑。

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

createTimestring
僅限輸出

當群組會員資格被創建時的時戳。. 此字串的格式為 Timestamp

updateTimestring
僅限輸出

群組會員最後更新時間戳。. 此字串的格式為 Timestamp

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

列出群組成員資格
Beta

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

在群組中列出群組成員。

請求路徑參數
group_idstring
需要

群組ID。.

查詢參數
maxPageSizenumber

要返回的群組會員最大數量。服務可能會返回少於此值。如果未指定,最多返回 10 個群組會員資格。最大值為 100,高於 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"
}