*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

GroupRole

Uma propriedade configurável para conceder privilégios específicos para membros dentro de um grupo.

Atributos

pathstring

O caminho de recursos do papel de grupo.

Formato: groups/{group_id}/roles/{group_role_id}.

createTimestring

Apenas saída

O timestamp para quando o papel de grupo foi atualizado pela última vez.

Visível apenas para os proprietários do grupo. Esta cadeia de caracteres é formatada como um Timestamp.

updateTimestring

Apenas saída

A data de registro quando o papel de grupo foi atualizado pela última vez.

Visível apenas para os proprietários do grupo. Esta cadeia de caracteres é formatada como um Timestamp.

idstring

Apenas saída

Um ID exclusivo que identifica um papel.

Distinto do rank de um papel, que é único apenas dentro do grupo.

displayNamestring

O nome do papel.

Tem um limite máximo de 100 caracteres. Nomes acima do limite são rejeitados.

descriptionstring

A descrição do papel.

Tem um limite máximo de 1000 caracteres. Cordas acima do limite são rejeitadas. Visível apenas para os proprietários do grupo.

ranknumber

A classificação do papel.

O valor mínimo é 0. O valor máximo é 255.

memberCountnumber

Apenas saída

Total de membros dentro de um papel.

Este campo não é retornado para papéis de convidado.

permissionsobject

As permissões concedidas para esse papel.

Este valor é preenchido com base no escopo de leitura e papel do usuário autorizado ou criador da chave da API.Se o usuário ou criador for o proprietário do grupo pai, eles podem ver todas as permissões de papel no grupo.Se o usuário ou criador for membro do grupo pai, ele poderá ver as permissões de seu papel no grupo.Qualquer pessoa pode ver as permissões de convidados.No caso de alguém não conseguir ver as permissões, este campo não é retornado.

URL base

https://apis.roblox.com

O recurso 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

Liste papéis em um grupo.

O campo de permissões para papéis é visualizável com base no acesso e nos escopos do requerente.

As permissões para o papel de convidado são sempre visíveis - não é necessário um escopo.

Se o requerente for um membro do grupo e tiver o escopo group:read, as permissões em seu papel são visíveis.

Se o solicitante for o proprietário do grupo e tiver o escopo group:read, as permissões em todos os papéis são visíveis.

SolicitaçãoParâmetros de endereço

group_idstring

Obrigatório

O ID do grupo.

Parâmetros da consulta

maxPageSizenumber

O número máximo de papéis de grupo a retornar.O serviço pode retornar menos que esse valor.Se não especificado, no máximo 10 papéis de grupo são retornados.O valor máximo é 20 e valores maiores são definidos como 20.

pageTokenstring

Um token de página, recebido de uma chamada anterior, para recuperar uma página posterior.

Ao paginar, todos os outros parâmetros fornecidos à chamada posterior devem corresponder à chamada que forneceu o token da página.

Resposta

Uma lista de Grupos de Papéis na coleçõespai.

groupRolesarray<GroupRole>

Os papéis de grupo do grupo especificado.

nextPageTokenstring

Um token que você pode enviar como um parâmetro pageToken para recuperar a próxima página. Se este campo for omitido, não há páginas subsequentes.

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}'

Resposta

{
  "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}

Obtenha o papel de grupo

SolicitaçãoParâmetros de endereço

group_idstring

Obrigatório

O ID do grupo.

role_idstring

Obrigatório

O ID do papel.

RespostaGroupRole

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}'

Resposta

{
  "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

Atributos

GroupRole

List Group RolesBeta

GroupRole

Get Group RoleBeta

List Group Roles
Beta

Get Group Role
Beta