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

GroupRole

可配置的屬性，可為群組內的會員授予特定權限。

特性

pathstring

群組角色的資源路徑。

格式：groups/{group_id}/roles/{group_role_id}.

createTimestring

僅限輸出

群組角色上次更新時的時戳。

僅對群組的擁有者可見。. 此字串的格式為 Timestamp。

updateTimestring

僅限輸出

群組角色上次更新時的時戳。

僅對群組的擁有者可見。. 此字串的格式為 Timestamp。

idstring

僅限輸出

一個唯一標識角色的ID。

與角色的等級不同，只在群組內是唯一的。.

displayNamestring

角色的名稱。

最多限制為 100 個字符。超出限制的名稱將被拒絕。.

descriptionstring

角色的說明。

具有最大限制為 1000 個字元。超出限制的字串被拒絕。只對群組的所有者可見。.

ranknumber

角色的等級。

最小值為 0。最大值為 255。.

memberCountnumber

僅限輸出

角色內的會員總數。

此欄位對訪客角色不予返回。.

permissionsobject

為此角色授予的許可。

此值會根據授權使用者或 API 鑰匙創建者的閱讀範圍和角色填充。如果使用者或創作者是父群的擁有者，他們就能查看群組中所有角色權限。如果使用者或創作者是父組成員，他們就能在群組中查看自己的角色權限。任何人都可以查看訪客權限。如果有人無法查看許可，此欄位不會返回。.

基本網址

https://apis.roblox.com

GroupRole資源

{
  "path": "groups/123/roles/123",
  "createTime": "2023-07-05T12:34:56Z",
  "updateTime": "2023-07-05T12:34:56Z",
  "id": "200",
  "displayName": "Member",
  "description": "This is a description for the role",
  "rank": 1,
  "memberCount": 10223136,
  "permissions": {
    "viewWallPosts": true,
    "createWallPosts": true,
    "deleteWallPosts": true,
    "viewGroupShout": true,
    "createGroupShout": true,
    "changeRank": true,
    "acceptRequests": true,
    "exileMembers": true,
    "manageRelationships": true,
    "viewAuditLog": true,
    "spendGroupFunds": true,
    "advertiseGroup": true,
    "createAvatarItems": true,
    "manageAvatarItems": true,
    "manageGroupUniverses": true,
    "viewUniverseAnalytics": true,
    "createApiKeys": true,
    "manageApiKeys": true,
    "banMembers": true,
    "viewForums": true,
    "manageCategories": true,
    "createPosts": true,
    "lockPosts": true,
    "pinPosts": true,
    "removePosts": true,
    "createComments": true,
    "removeComments": true
  }
}

GroupRole

List Group Roles
Beta

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

列出群組中的角色。

角色的權限欄可以根據請求者的訪問權限和範圍查看。

訪客角色的許可始終可見，不需要範圍。

如果要求者是群組成員且擁有 group:read 範圍，他們的角色權限就會可見。

如果要求者是群組的所有者並擁有 group:read 範圍，所有角色的權限都會可見。

請求路徑參數

group_idstring

需要

群組ID。.

查詢參數

maxPageSizenumber

要返傳回的群組角色最大數量。服務可能會返回少於此值。如果未指定，最多只返回 10 個群組角色。最大值為 20，高於 20 的值設為 20。.

pageTokenstring

從以前的呼叫中收到的頁面代幣，用於取回後續頁面。

當頁面分頁時，所有其他參數提供給後續呼叫的頁面代幣必須與提供頁面代幣的呼叫匹配。.

回應

父收藏合中的群組角色列表。

groupRolesarray<GroupRole>

指定群組的群組角色。.

nextPageTokenstring

您可以將其作為pageToken參數發送到回收下一頁的代幣。如果此欄位被忽略，就沒有後續頁面。.

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

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

回應

{
  "groupRoles": [
    {
      "path": "groups/123/roles/123",
      "createTime": "2023-07-05T12:34:56Z",
      "updateTime": "2023-07-05T12:34:56Z",
      "id": "200",
      "displayName": "Member",
      "description": "This is a description for the role",
      "rank": 1,
      "memberCount": 10223136,
      "permissions": {
        "viewWallPosts": true,
        "createWallPosts": true,
        "deleteWallPosts": true,
        "viewGroupShout": true,
        "createGroupShout": true,
        "changeRank": true,
        "acceptRequests": true,
        "exileMembers": true,
        "manageRelationships": true,
        "viewAuditLog": true,
        "spendGroupFunds": true,
        "advertiseGroup": true,
        "createAvatarItems": true,
        "manageAvatarItems": true,
        "manageGroupUniverses": true,
        "viewUniverseAnalytics": true,
        "createApiKeys": true,
        "manageApiKeys": true,
        "banMembers": true,
        "viewForums": true,
        "manageCategories": true,
        "createPosts": true,
        "lockPosts": true,
        "pinPosts": true,
        "removePosts": true,
        "createComments": true,
        "removeComments": true
      }
    }
  ],
  "nextPageToken": "string"
}

GroupRole

Get Group Role
Beta

GET /cloud/v2/groups/{group_id}/roles/{role_id}

獲得群組角色

請求路徑參數

group_idstring

需要

群組ID。.

role_idstring

需要

角色ID。.

回應GroupRole

GET /cloud/v2/groups/{group_id}/roles/{role_id}

curl -L -X GET 'https://apis.roblox.com/cloud/v2/groups/{group_id}/roles/{role_id}' \
  -H 'x-api-key: {your-api-key}'

回應

{
  "path": "groups/123/roles/123",
  "createTime": "2023-07-05T12:34:56Z",
  "updateTime": "2023-07-05T12:34:56Z",
  "id": "200",
  "displayName": "Member",
  "description": "This is a description for the role",
  "rank": 1,
  "memberCount": 10223136,
  "permissions": {
    "viewWallPosts": true,
    "createWallPosts": true,
    "deleteWallPosts": true,
    "viewGroupShout": true,
    "createGroupShout": true,
    "changeRank": true,
    "acceptRequests": true,
    "exileMembers": true,
    "manageRelationships": true,
    "viewAuditLog": true,
    "spendGroupFunds": true,
    "advertiseGroup": true,
    "createAvatarItems": true,
    "manageAvatarItems": true,
    "manageGroupUniverses": true,
    "viewUniverseAnalytics": true,
    "createApiKeys": true,
    "manageApiKeys": true,
    "banMembers": true,
    "viewForums": true,
    "manageCategories": true,
    "createPosts": true,
    "lockPosts": true,
    "pinPosts": true,
    "removePosts": true,
    "createComments": true,
    "removeComments": true
  }
}

GroupRole

特性

GroupRole

List Group RolesBeta

GroupRole

Get Group RoleBeta

List Group Roles
Beta

Get Group Role
Beta