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

GroupRole

可配置的属性，可为群组内的成员授予特定权限。

属性

pathstring

群组角色的资源路径。

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

createTimestring

仅输出

群组角色最后更新时的时戳。

仅对群组的所有者可见。. 此字符串格式为 FieldMask。

updateTimestring

仅输出

群组角色最后更新时间戳。

仅对群组的所有者可见。. 此字符串格式为 FieldMask。

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。.

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