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

GroupMembership

Un adhésion à un groupe. Un ID d'utilisateur peut être utilisé à la place d'un ID d'adhésion.

Attributs

pathstring

Le chemin de ressource de l'adhésion au groupe.

Format : groups/{group_id}/memberships/{group_membership_id}.

createTimestring
Sortie seule

La date et l'heure de création de l'adhésion au 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 membre du groupe. Ce string est formatée en tant que Timestamp.

userstring
Immuable

Le chemin de ressource d'un membre du groupe.

rolestring

Le chemin de ressource pour le rôle du membre du groupe.

URL de base

https://apis.roblox.com
La ressource GroupMembership

{
"path": "groups/123/memberships/123",
"createTime": "2023-07-05T12:34:56Z",
"updateTime": "2023-07-05T12:34:56Z",
"user": "users/21557",
"role": "groups/7/roles/99513316"
}

GroupMembership

Liste des adhésions de groupe
Bêta

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

Listez les membres du groupe dans un groupe.

RequêteParamètres du chemin
group_idstring
Requis

L'ID du groupe.

Paramètres de requête
maxPageSizenumber

Le nombre maximum de membres de groupe à retourner.Le service peut retourner moins que cette valeur.Si non spécifié, au maximum 10 adhésions de groupe sont retournées.La valeur maximale est de 100 et les valeurs plus élevées sont réglées sur 100.

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.

filterstring

Ce champ peut être défini afin de filtrer les ressources renvoyées.

Voir la documentation filtrage pour plus d'informations.

Réponse

Une liste de membres de groupe dans la collection parent.

groupMembershipsarray<GroupMembership>

Les adhésions de groupe de l'ensemble spécifié.

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}/memberships

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

{
"groupMemberships": [
{
"path": "groups/123/memberships/123",
"createTime": "2023-07-05T12:34:56Z",
"updateTime": "2023-07-05T12:34:56Z",
"user": "users/21557",
"role": "groups/7/roles/99513316"
}
],
"nextPageToken": "string"
}

GroupMembership

Mise à jour de l'adhésion au groupe
Bêta

PATCH /cloud/v2/groups/{group_id}/memberships/{membership_id}

Mise à jour de l'adhésion au groupe pour un membre spécifique du groupe.Cette action nécessite que le requérant soit en mesure de gérer des membres de rang inférieur.Les rangs de visiteur ou de propriétaire ne peuvent pas être attribués, et un demandeur ne peut pas changer son propre rang.

Périmètres d'application
group:write
RequêteParamètres du chemin
group_idstring
Requis

L'ID du groupe.

membership_idstring
Requis

L'ID de membre.

Corps de la requêteGroupMembership
PATCH /cloud/v2/groups/{group_id}/memberships/{membership_id}

curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/groups/{group_id}/memberships/{membership_id}' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"role": "groups/7/roles/99513316"
}'
Réponse

{
"path": "groups/123/memberships/123",
"createTime": "2023-07-05T12:34:56Z",
"updateTime": "2023-07-05T12:34:56Z",
"user": "users/21557",
"role": "groups/7/roles/99513316"
}