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

GroupMembership

Una membresía a un grupo. Un ID de usuario se puede utilizar en lugar de un ID de membresía.

Atributos

pathstring

El camino de recursos de la membresía del grupo.

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

createTimestring
Solo salida

La fecha y hora en que se creó la membresía del grupo. Esta cadena está formateada como Timestamp.

updateTimestring
Solo salida

La fecha y hora en que se actualizó por última vez la membresía del grupo. Esta cadena está formateada como Timestamp.

userstring
Inmutable

El camino de recursos de un miembro del grupo.

rolestring

El camino de recursos para el rol del miembro del grupo.

URL base

https://apis.roblox.com
El recurso 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

Lista de membresías de grupo
Beta

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

Lista los miembros del grupo en un grupo.

SolicitudParámetros de ruta
group_idstring
Obligatorio

El ID del grupo.

Parámetros de consulta
maxPageSizenumber

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

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.

filterstring

Este campo se puede configurar para filtrar los recursos devueltos.

Consulte la documentación de filtrado para obtener más información.

Respuesta

Una lista de membresías de grupo en la colección padre.

groupMembershipsarray<GroupMembership>

Las membresías de grupo de la membresía 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}/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}'
Respuesta

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

Actualizar la membresía del grupo
Beta

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

Actualiza la membresía del grupo para un miembro particular del grupo.Esta acción requiere que el solicitante pueda administrar miembros de rango inferior.No se pueden asignar rangos de invitado o propietario y un solicitante no puede cambiar su propio rango.

Ámbitos
group:write
SolicitudParámetros de ruta
group_idstring
Obligatorio

El ID del grupo.

membership_idstring
Obligatorio

El ID de membresía.

Solicitar cuerpoGroupMembership
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"
}'
Respuesta

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