*Este contenido se traduce usando la IA (Beta) y puede contener errores. Para ver esta página en inglés, haz clic en aquí.

GroupRole

Una propiedad configurable para otorgar privilegios específicos para los miembros dentro de un grupo.

Atributos

pathstring

El camino de recursos del rol de grupo.

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

createTimestring

Solo salida

La fecha y hora en que se actualizó por última vez el rol de grupo.

Solo visible para los propietarios del grupo. Esta cadena está formateada como Timestamp.

updateTimestring

Solo salida

La fecha y hora en que se actualizó por última vez el rol de grupo.

Solo visible para los propietarios del grupo. Esta cadena está formateada como Timestamp.

idstring

Solo salida

Una identificación única que identifica un rol.

Distinto del rango de un rol, que solo es único dentro del grupo.

displayNamestring

El nombre del rol.

Tiene un límite máximo de 100 caracteres. Los nombres por encima del límite se rechazan.

descriptionstring

La descripción del rol.

Tiene un límite máximo de 1000 caracteres. Las cadenas por encima del límite se rechazan. Solo son visibles para los propietarios del grupo.

ranknumber

El rango del rol.

El valor mínimo es 0. El valor máximo es 255.

memberCountnumber

Solo salida

Número total de miembros dentro de un rol.

Este campo no se devuelve para roles de invitados.

permissionsobject

Los permisos otorgados para este rol.

Este valor se rellena según el alcance de lectura y el rol del usuario autorizado o creador de la clave API.Si el usuario o creador es el propietario del grupo padre, pueden ver todas las permisos de rol en el grupo.Si el usuario o creador es miembro del grupo padre, pueden ver las permisos de su rol en el grupo.Cualquiera puede ver las permisos de invitados.En el caso de que alguien no pueda ver las permisos, este campo no se devuelve.

URL base

https://apis.roblox.com

El 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

Lista los roles en un grupo.

El campo de permisos para roles es visible según el acceso y los alcances del solicitante.

Las autorizaciones para el rol de invitado siempre son visibles: no se necesita un alcance.

Si el solicitante es un miembro del grupo y tiene el alcance group:read, las permisos en su rol son visibles.

Si el solicitante es el propietario del grupo y tiene el alcance group:read, las permisos en todos los roles son visibles.

SolicitudParámetros de ruta

group_idstring

Obligatorio

El ID del grupo.

Parámetros de consulta

maxPageSizenumber

El número máximo de roles de grupo para devolver.El servicio podría devolver menos que este valor.Si no se especifica, se devuelven un máximo de 10 roles de grupo.El valor máximo es 20 y los valores más altos se establecen en 20.

pageTokenstring

Una ficha de página, recibida de una llamada anterior, para recuperar una página posterior.

Al paginar, todos los demás parámetros proporcionados a la llamada siguiente deben coincidir con la llamada que proporcionó el token de página.

Respuesta

Una lista de roles de grupo en la coleccionespadre.

groupRolesarray<GroupRole>

Los roles de grupo de la función especificada del grupo.

nextPageTokenstring

Una token que puedes enviar como parámetro pageToken para recuperar la siguiente página. Si este campo se omite, no hay páginas posteriores.

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

Respuesta

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

Obtener el rol de grupo

SolicitudParámetros de ruta

group_idstring

Obligatorio

El ID del grupo.

role_idstring

Obligatorio

El ID de rol.

RespuestaGroupRole

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

Respuesta

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