*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

GroupRole

Une propriété configurable pour accorder des privilèges spécifiques aux membres d'un groupe.

Attributs

pathstring

Le chemin de ressource du rôle de groupe.

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

createTimestring

Sortie seule

L'horodatage de la dernière mise à jour du rôle de groupe.

Visible uniquement pour les propriétaires du groupe. Ce string est formatée en tant que Timestamp.

updateTimestring

Sortie seule

La date et l'heure de la dernière mise à jour du rôle de groupe.

Visible uniquement pour les propriétaires du groupe. Ce string est formatée en tant que Timestamp.

idstring

Sortie seule

Un ID unique qui identifie un rôle.

Distingue du rang d'un rôle, qui n'est unique que dans le groupe.

displayNamestring

Le nom du rôle.

A une limite maximale de 100 caractères. Les noms au-dessus de la limite sont rejetés.

descriptionstring

La description du rôle.

A une limite maximale de 1000 caractères. Les chaînes au-dessus de la limite sont rejetées. Visibles uniquement aux propriétaires du groupe.

ranknumber

Le rang du rôle.

La valeur minimale est 0. La valeur maximale est 255.

memberCountnumber

Sortie seule

Nombre total de membres dans un rôle.

Ce champ n'est pas renvoyé pour les rôles d'invité.

permissionsobject

Les permissions accordées pour ce rôle.

Cette valeur est remplie en fonction de la portée de lecture et du rôle de l'utilisateur autorisé ou du créateur de clé API.Si l'utilisateur ou le créateur est le propriétaire du groupe parent, il peut voir toutes les permissions de rôle dans le groupe.Si l'utilisateur ou le créateur est membre du groupe parent, il peut voir les permissions de son rôle dans le groupe.Tout le monde peut voir les permissions des invités.Dans le cas où quelqu'un ne peut pas voir les permissions, ce champ n'est pas renvoyé.

URL de base

https://apis.roblox.com

La ressource 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
Bêta

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

Listez les rôles dans un groupe.

Le champ des permissions pour les rôles est visible en fonction de l'accès et des scopes du requérant.

Les permissions pour le rôle d'invité sont toujours visibles - une portée n'est pas nécessaire.

Si le requérant est un membre du groupe et a la portée group:read, les permissions dans son rôle sont visibles.

Si le requérant est le propriétaire du groupe et a la portée group:read, les permissions dans tous les rôles sont visibles.

RequêteParamètres du chemin

group_idstring

Requis

L'ID du groupe.

Paramètres de requête

maxPageSizenumber

Le nombre maximum de rôles de groupe à renvoyer.Le service peut retourner moins que cette valeur.Si non spécifié, au maximum 10 rôles de groupe sont renvoyés.La valeur maximale est de 20 et les valeurs plus élevées sont réglées sur 20.

pageTokenstring

Un jeton de page, reçu d'un appel précédent, pour récupérer une page suivante.

Lors de la pagination, tous les autres paramètres fournis à l'appel suivant doivent correspondre à l'appel qui a fourni le jeton de page.

Réponse

Une liste de rôles de groupe dans la collectionsparent.

groupRolesarray<GroupRole>

Les rôles de groupe de la catégorie spécifiée.

nextPageTokenstring

Un jeton que vous pouvez envoyer en tant que pageToken paramètre pour récupérer la page suivante. Si ce champ est omis, il n'y a pas de pages suivantes.

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

Réponse

{
  "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
Bêta

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

Obtenir le rôle de groupe

RequêteParamètres du chemin

group_idstring

Requis

L'ID du groupe.

role_idstring

Requis

L'ID du rôle.

RéponseGroupRole

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

Réponse

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

Attributs

GroupRole

List Group RolesBêta

GroupRole

Get Group RoleBêta

List Group Roles
Bêta

Get Group Role
Bêta