*Konten ini diterjemahkan menggunakan AI (Beta) dan mungkin mengandung kesalahan. Untuk melihat halaman ini dalam bahasa Inggris, klik di sini.

GroupRole

Properti yang dapat disetel untuk memberikan hak istimewa khusus bagi anggota dalam grup.

Atribut

pathstring

Jalur sumber daya dari peran kelompok.

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

createTimestring

Hanya Output

Stempel waktu ketika peran kelompok terakhir diperbarui.

Hanya terlihat oleh pemilik grup. String ini diformat sebagai Timestamp.

updateTimestring

Hanya Output

Stempel waktu ketika peran kelompok terakhir diperbarui.

Hanya terlihat oleh pemilik grup. String ini diformat sebagai Timestamp.

idstring

Hanya Output

ID unik yang mengidentifikasi peran.

Berbeda dari peringkat peran, yang hanya unik dalam grup.

displayNamestring

Nama peran.

Memiliki batas maksimal 100 karakter. Nama di atas batas ditolak.

descriptionstring

Deskripsi peran.

Memiliki batas maksimum 1000 karakter. String di atas batas ditolak. Hanya terlihat oleh pemilik grup.

ranknumber

Peringkat peran.

Nilai minimum adalah 0. Nilai maksimum adalah 255.

memberCountnumber

Hanya Output

Jumlah total anggota dalam peran.

Bidang ini tidak dikembalikan untuk peran tamu.

permissionsobject

Izin yang diberikan untuk peran ini.

Nilai ini diisi berdasarkan scope baca dan peran pengguna atau kunci API yang berwenang.Jika pengguna atau pencipta adalah pemilik gruporang tua, mereka dapat melihat semua izin peran di grup.Jika pengguna atau kreator adalah anggota gruporangtua, mereka dapat melihat izin peran mereka di grup.Siapa pun dapat melihat izin tamu.Dalam kasus di mana seseorang tidak dapat melihat izin, bidang ini tidak dikembalikan.

Base URL

https://apis.roblox.com

Resource 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

Daftar peran dalam grup.

Bidang izin untuk peran dapat dilihat berdasarkan akses dan cakupan pencari.

Izin untuk peran tamu selalu terlihat - scope tidak diperlukan.

Jika pencari adalah anggota kelompok dan memiliki scope group:read, izin dalam peran mereka terlihat.

Jika pencari adalah pemilik kelompok dan memiliki scope group:read, izin di semua peran terlihat.

PermintaanParameter Jalur

group_idstring

Diperlukan

ID kelompok.

Parameter Kueri

maxPageSizenumber

Jumlah peran kelompok maksimum untuk dikembalikan.Layanan mungkin kembali kurang dari nilai ini.Jika tidak ditentukan, paling banyak 10 peran kelompok dikembalikan.Nilai maksimum adalah 20 dan nilai lebih tinggi ditetapkan ke 20.

pageTokenstring

Token halaman, diterima dari panggilan sebelumnya, untuk mengambil halaman berikutnya.

Saat paginasi, semua parameter lain yang disediakan untuk panggilan berikutnya harus cocok dengan panggilan yang memberikan token halaman.

Respons

Daftar Peran Grup di koleksi orangtua.

groupRolesarray<GroupRole>

Peran Grup dari Grup yang ditentukan.

nextPageTokenstring

Token yang dapat Anda kirim sebagai parameter pageToken untuk mengambil halaman berikutnya. Jika bidang ini diabaikan, tidak ada halaman berikutnya.

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

Respons

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

Dapatkan peran kelompok

PermintaanParameter Jalur

group_idstring

Diperlukan

ID kelompok.

role_idstring

Diperlukan

ID peran.

ResponsGroupRole

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

Respons

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

Atribut

GroupRole

List Group RolesBeta

GroupRole

Get Group RoleBeta

List Group Roles
Beta

Get Group Role
Beta