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

GroupRole

Eine konfigurierbare Eigenschaft, um bestimmten Privilegien für Mitglieder innerhalb einer Gruppe zu gewähren.

Attribute

pathstring

Der Ressourcenpfad der Gruppenrolle.

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

createTimestring
Nur Ausgabe

Der Zeitstempel für die letzte Aktualisierung der Gruppenrolle.

Sichtbar nur für die Eigentümer der Gruppe. Dieser String ist als Zeitstempel formatiert.

updateTimestring
Nur Ausgabe

Der Zeitpunkt, zu dem die Gruppenrolle zuletzt aktualisiert wurde.

Sichtbar nur für die Eigentümer der Gruppe. Dieser String ist als Zeitstempel formatiert.

idstring
Nur Ausgabe

Eine eindeutige ID, die eine Rolle identifiziert.

Unterscheidet sich vom Rang einer Rolle, der nur innerhalb der Gruppe einzigartig ist.

displayNamestring

Der Name der Rolle.

Hat ein Maximum von 100 Zeichen. Namen über dem Limit werden abgelehnt.

descriptionstring

Die Beschreibung der Rolle.

Hat ein Maximum von 1000 Zeichen. Zeichen über dem Limit werden abgelehnt. Nur für Besitzer der Gruppe sichtbar.

ranknumber

Der Rang der Rolle.

Der minimale Wert ist 0. Der maximale Wert ist 255.

memberCountnumber
Nur Ausgabe

Gesamtzahl der Mitglieder innerhalb einer Rolle.

Dieses Feld wird für Gastrollen nicht zurückgegeben.

permissionsobject

Die Berechtigungen, die für diese Rolle gewährt wurden.

Dieser Wert wird basierend auf dem Lesebereich und der Rolle des autorisierten Benutzers oder des Creator:inausgefüllt.Wenn der Benutzer oder Ersteller der Eigentümer der übergeordneten Gruppe ist, kann er alle Rollenberechtigungen in der Gruppe anzeigen.Wenn der Benutzer oder die Erstellerin Mitglied der übergeordneten Gruppe ist, kann sie die Berechtigungen ihrer Rolle in der Gruppe anzeigen.Jeder kann die Berechtigungen von Gästen anzeigen.Im Fall, dass jemand die Berechtigungen nicht anzeigen kann, wird dieses Feld nicht zurückgegeben.

Basis-URL

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

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

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

Listenrollen in einer Gruppe.

Das Berechtigungsfeld für Rollen ist abhängig vom Zugriff und den Bereichen des Anfragenden anzeigbar.

Berechtigungen für die Gastrolle sind immer sichtbar - ein Umfang ist nicht erforderlich.

Wenn der Anfragende Mitglied der Gruppe ist und den group:read Umfang hat, sind die Berechtigungen in ihrer Rolle sichtbar.

Wenn der Anfragende der Eigentümer der Gruppe ist und den group:read Umfang hat, sind Berechtigungen in allen Rollen sichtbar.

AnfragePfadparameter
group_idstring
Erforderlich

Die Gruppen-ID.

Anfrageparameter
maxPageSizenumber

Die maximale Anzahl von Gruppenrollen, die zurückzukehren sind.Der Dienst könnte weniger als diesen Wert zurückgeben.Wenn nicht spezifiziert, werden höchstens 10 Gruppenrollen zurückgegeben.Der maximale Wert ist 20 und höhere Werte werden auf 20 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.

Rückmeldung

Eine Liste von Gruppenrollen in der übergeordneten Sammlungen.

groupRolesarray<GroupRole>

Die Gruppenrollen 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}/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ückmeldung

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

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

Hole die Gruppenrolle

AnfragePfadparameter
group_idstring
Erforderlich

Die Gruppen-ID.

role_idstring
Erforderlich

Die Rollen-ID.

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

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