*Dieser Inhalt wurde mit KI (Beta) übersetzt und kann Fehler enthalten. Um diese Seite auf Englisch zu sehen, klicke hier.

GroupMembership

Eine Mitgliedschaft in einer Gruppe. Eine Benutzer-ID kann anstelle einer Mitgliedschafts-ID verwendet werden.

Attribute

pathstring

Der Ressourcenpfad der Gruppenmitgliedschaft.

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

createTimestring
Nur Ausgabe

Der Zeitpunkt, an dem die Gruppenmitgliedschaft erstellt wurde. Dieser String ist als Zeitstempel formatiert.

updateTimestring
Nur Ausgabe

Der Zeitpunkt, zu dem die Gruppenmitgliedschaft zuletzt aktualisiert wurde. Dieser String ist als Zeitstempel formatiert.

userstring
Unveränderlich

Der Ressourcenpfad eines Mitglieds der Gruppe.

rolestring

Der Ressourcenpfad für die Rolle des Gruppenmitglieds.

Basis-URL

https://apis.roblox.com
Die GroupMembership-Ressource

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

Gruppenmitgliedschaften listen
Beta

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

Liste Gruppenmitglieder in einer Gruppe.

AnfragePfadparameter
group_idstring
Erforderlich

Die Gruppen-ID.

Anfrageparameter
maxPageSizenumber

Die maximale Anzahl der Gruppenmitgliedschaften, die zurückzukehren sind.Der Dienst könnte weniger als diesen Wert zurückgeben.Wenn nicht spezifiziert, werden höchstens 10 Gruppenmitgliedschaften zurückgegeben.Der maximale Wert beträgt 100, und höhere Werte werden auf 100 festgelegt.

pageTokenstring

Ein Seiten-Token, das von einer früheren Anruf erhalten wurde, um eine nachfolgende Seite abzurufen.

Wenn Seiten nummeriert werden, müssen alle anderen Parameter, die der nachfolgenden Anruf bereitgestellt hat, dem Anruf entsprechen, der das Seiten-Token bereitgestellt hat.

filterstring

Dieses Feld kann festgelegt werden, um die zurückgegebenen Ressourcen zu filtern.

Siehe die Filterung-Dokumentation für weitere Informationen.

Rückmeldung

Eine Liste der Gruppenmitgliedschaften in der übergeordneten Sammlung.

groupMembershipsarray<GroupMembership>

Die Gruppenmitgliedschaften aus der angegebenen Gruppe.

nextPageTokenstring

Ein Token, das du als pageToken-Parameter senden kannst, um die nächste Seite abzurufen. Wenn dieses Feld ausgelassen wird, gibt es keine nachfolgenden Seiten.

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ückmeldung

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

Gruppenmitgliedschaft aktualisieren
Beta

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

Aktualisiert die Gruppenmitgliedschaft für ein bestimmtes Gruppenmitglied.Diese Aktion erfordert, dass der Anfragende in der Lage ist, niedrig rangierte Mitglieder zu verwalten.Gäste- oder Eigentümerränge können nicht zugewiesen werden, und ein Anfragender kann seinen eigenen Rang nicht ändern.

Bereiche
group:write
AnfragePfadparameter
group_idstring
Erforderlich

Die Gruppen-ID.

membership_idstring
Erforderlich

Die Mitglieds-ID.

Text anfordernGroupMembership
RückmeldungGroupMembership
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ückmeldung

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