*Ta zawartość została przetłumaczona przy użyciu narzędzi AI (w wersji beta) i może zawierać błędy. Aby wyświetlić tę stronę w języku angielskim, kliknij tutaj.

GroupRole

Konfigurowalna właściwość, która przyznaje określone uprawnienia dla członków w grupa.

Atrybuty

pathstring

Ścieżka zasobów roli grupowej.

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

createTimestring

Tylko dane wyjściowe

Data i czas aktualizacji roli grupy po raz ostatni.

Widoczny tylko dla właścicieli grupa. Ten ciąg jest sformatowany jako Timestamp.

updateTimestring

Tylko dane wyjściowe

Data i czas aktualizacji roli grupy po raz ostatni.

Widoczny tylko dla właścicieli grupa. Ten ciąg jest sformatowany jako Timestamp.

idstring

Tylko dane wyjściowe

Unikalny identyfikator, który identyfikuje rolę.

Odróżnia się od rangi roli, która jest unikalna tylko w grupa.

displayNamestring

Nazwa roli.

Ma maksymalny limit 100 znaków. Nazwy powyżej limitu są odrzucane.

descriptionstring

Opis roli.

Ma maksymalny limit 1000 znaków. Struny powyżej limitu są odrzucane. Widoczne tylko dla właścicieli grupa.

ranknumber

Pozycja roli.

Minimalna wartość wynosi 0. Maksymalna wartość wynosi 255.

memberCountnumber

Tylko dane wyjściowe

Całkowita liczba członków w ramach roli.

To pole nie jest zwracane dla roli gościa.

permissionsobject

Uprawnienia przyznane dla tej roli.

Wartość ta jest wypełniona w oparciu o zakres czytania i rolę autoryzowanego użytkownika lub twórcę klucza API.Jeśli użytkownik lub twórca jest właścicielem grupamacierzowej, może on zobaczyć wszystkie uprawnienia roli w grupa.Jeśli użytkownik lub twórca jest członkiem grupamacierzystej, może on zobaczyć uprawnienia swojej roli w grupa.Każdy może zobaczyć uprawnienia gościa.W przypadku, gdy ktoś nie może zobaczyć uprawnień, to pole nie jest zwracane.

Podstawowy adres URL

https://apis.roblox.com

Zasób GroupRole

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

Wyświetl role w grupa.

Pole uprawnień dla roli jest widoczne w oparciu o dostęp i zakres wymagającego.

Uprawnienia dla roli gościa są zawsze widoczne - nie jest potrzebny zakres.

Jeśli wnioskodawca jest członkiem grupy i ma zakres group:read, uprawnienia w jego roli są widoczne.

Jeśli wnioskodawca jest właścicielem grupy i ma zakres group:read, uprawnienia we wszystkich rolach są widoczne.

ŻądanieParametry ścieżki

group_idstring

Wymagane

Identyfikator grupy.

Parametry zapytania

maxPageSizenumber

Maksymalna liczba ról grupowych do zwrotu.Usługa może zwrócić mniej niż tę wartość.Jeśli nie określono, zwracane są maksymalnie 10 ról grupowych.Maksymalna wartość wynosi 20, a wyższe wartości są ustawione na 20.

pageTokenstring

Żeton strony, otrzymany z poprzedniego wezwania, aby odzyskać następną stronę.

Podczas paginowania wszystkie pozostałe parametry dostarczone do następnego wezwania muszą pasować do wezwania, które dostarczyło token strony.

Odpowiedź:

Lista ról grupowych w kolekcjamacierzystej.

groupRolesarray<GroupRole>

Role grupowe z określonej grupy.

nextPageTokenstring

Token, który możesz wysłać jako parametr pageToken w celu odzyskania następnej strony. Jeśli to pole zostanie pominięte, nie ma następnych stron.

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}'

Odpowiedź:

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

Zdobądź rolę grupy

ŻądanieParametry ścieżki

group_idstring

Wymagane

Identyfikator grupy.

role_idstring

Wymagane

Identyfikator roli.

Odpowiedź:GroupRole

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}'

Odpowiedź:

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

Atrybuty

GroupRole

List Group RolesBeta

GroupRole

Get Group RoleBeta

List Group Roles
Beta

Get Group Role
Beta