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

GroupMembership

Uma associação a um grupo. Um ID de usuário pode ser usado em vez de um ID de associação.

Atributos

pathstring

O caminho de recursos da adesão ao grupo.

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

createTimestring
Apenas saída

A data de registro quando a adesão ao grupo foi criada. Esta cadeia de caracteres é formatada como um Timestamp.

updateTimestring
Apenas saída

A data de quando a adesão ao grupo foi atualizada pela última vez. Esta cadeia de caracteres é formatada como um Timestamp.

userstring
Imutável

O caminho de recursos de um membro do grupo.

rolestring

O caminho de recursos para o papel do membro do grupo.

URL base

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

Listar Associações de Grupo
Beta

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

Liste os membros do grupo em um grupo.

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 associações de grupo a retornar.O serviço pode retornar menos que esse valor.Se não especificado, no máximo 10 associações de grupo são retornadas.O valor máximo é 100 e valores mais altos são definidos como 100.

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.

filterstring

Este campo pode ser definido para filtrar os recursos retornados.

Veja a documentação de filtragem para mais informações.

Resposta

Uma lista de Grupos de Membros na coleção pai.

groupMembershipsarray<GroupMembership>

As Associações 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}/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}'
Resposta

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

Atualizar afiliação de grupo
Beta

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

Atualiza a adesão do grupo para um membro de grupo específico.Essa ação requer que o solicitante seja capaz de gerenciar membros de menor rank.Não é possível atribuir ranks de Convidado ou de Proprietário e um requerente não pode alterar seu próprio rank.

Escopos
group:write
SolicitaçãoParâmetros de endereço
group_idstring
Obrigatório

O ID do grupo.

membership_idstring
Obrigatório

O ID de membros.

Requisitar corpoGroupMembership
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"
}'
Resposta

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