Topik ini menjelaskan metode yang digunakan untuk mengelola grup dan anggotanya.
Parameter options dari tipe IPDSRequestConfig dienkapsulasi berdasarkan opsi konfigurasi permintaan axios. Untuk informasi lebih lanjut, lihat AxiosRequestConfig.
createGroup
Untuk memanggil metode ini, Anda harus memiliki izin administrator atau menjadi administrator grup.
Membuat grup baru.
const result = await client.createGroup(params, options)Kode contoh
await client.createGroup({
group_name: 'test',
description: '',
is_root: true
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | ICreatGroupReq | Ya | Informasi tentang grup. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
ICreatGroupReq
Parameter | Tipe | Diperlukan | Deskripsi |
group_name | string | Ya | Nama grup. |
description | string | Deskripsi grup. | |
is_root | boolean | Menentukan apakah grup adalah grup root. | |
parent_group_id | string | ID grup induk. Anda hanya dapat menentukan salah satu parameter parent_group_id dan is_root. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IGroupItem | Ya | Hasil yang dikembalikan. |
IGroupItem
Parameter | Tipe | Diperlukan | Deskripsi |
domain_id | string | ID domain. | |
group_id | string | ID grup. | |
group_name | string | Nama grup. | |
description | string | Deskripsi grup. | |
created_at | number | Waktu ketika grup dibuat. | |
updated_at | number | Waktu terakhir grup diperbarui. |
deleteGroup
Untuk memanggil metode ini, Anda harus memiliki izin administrator atau menjadi administrator grup.
Menghapus grup.
await client.deleteGroup(params, options)Kode contoh
await client.deleteGroup({
group_id: '0cbfe8de7d7645ea835b1b1a91101e4d'
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | Object | Ya | Parameter permintaan. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
params
Parameter | Tipe | Diperlukan | Deskripsi |
group_id | string | Ya | ID grup. |
Parameter respons
Tidak ada.
updateGroup
Untuk memanggil metode ini, Anda harus memiliki izin administrator atau menjadi administrator grup.
Memperbarui grup.
await client.updateGroup(params, options)Kode contoh
await client.updateGroup({
group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
group_name: 'new_name',
description: 'test'
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | IUpdateGroupReq | Ya | Parameter permintaan. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
IUpdateGroupReq
Parameter | Tipe | Diperlukan | Deskripsi |
group_id | string | Ya | ID grup. |
group_name | string | Nama grup. | |
description | string | Menentukan apakah grup adalah grup root. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IGroupItem | Ya | Hasil yang dikembalikan. |
getGroup
Mengambil informasi tentang sebuah grup.
const result = await client.getGroup(params, options)Kode contoh
const groupInfo = await client.getGroup({
group_id: '0cbfe8de7d7645ea835b1b1a91101e4d'
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | Object | Ya | Parameter permintaan. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
params
Parameter | Tipe | Diperlukan | Deskripsi |
group_id | string | Ya | ID grup. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IGroupItem | Ya | Hasil yang dikembalikan. |
listGroups
Mengambil daftar grup.
await client.listGroups(params, options)Kode contoh
await client.listGroups({
limit: 100,
marker:''
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | IListReq | Ya | Parameter permintaan. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
IListReq
Parameter | Tipe | Diperlukan | Deskripsi |
limit | number | Jumlah maksimum entri yang akan dikembalikan. Nilai valid: 1 hingga 100. Nilai default: 100. | |
marker | string | Pengenal awal dari kueri. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IListRes | Ya | Hasil yang dikembalikan. |
IListRes
Parameter | Tipe | Diperlukan | Deskripsi |
items | IGroupItem[] | Grup. | |
next_marker | string | Pengenal awal dari kueri berikutnya. |
searchGroups
Mengambil daftar grup dan mengurutkan berdasarkan waktu terakhir diperbarui secara menurun.
await client.searchGroups(params, options)const {items=[]} = await client.listGroups({
limit: 100,
marker:'',
group_name: 'test_group_name'
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | Object | Ya | Parameter permintaan. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
params
Parameter | Tipe | Diperlukan | Deskripsi |
limit | number | Jumlah maksimum entri yang akan dikembalikan. Nilai valid: 1 hingga 100. Nilai default: 100. | |
marker | string | Pengenal awal dari kueri. | |
group_name | string | Nama grup. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IListRes | Ya | Hasil yang dikembalikan. |
IListRes
Parameter | Tipe | Diperlukan | Deskripsi |
items | IGroupItem[] | Grup. | |
next_marker | string | Pengenal awal dari kueri berikutnya. |
listGroupMembers
Untuk memanggil metode ini, Anda harus memiliki izin administrator atau menjadi administrator grup.
Mengambil daftar anak grup atau pengguna dalam sebuah grup.
await client.listGroupMembers(params, options)Kode contoh
await client.listGroupMembers({
limit: 100,
marker:'',
group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
member_type: 'group'
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | Object | Ya | Parameter permintaan. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
params
Parameter | Tipe | Diperlukan | Deskripsi |
limit | number | Jumlah maksimum entri yang akan dikembalikan. Nilai valid: 1 hingga 100. Nilai default: 100. | |
marker | string | Pengenal awal dari kueri. | |
group_id | string | Ya | ID grup. |
member_type | string | Ya | Tipe anggota. Nilai valid: user dan group. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IListGroupMembersRes | Ya | Hasil yang dikembalikan. |
IListGroupMembersRes
Parameter | Tipe | Deskripsi |
user_items | IUserItem[] | Pengguna. |
group_items | IGroupItem[] | Grup. |
next_marker | string | Pengenal awal dari kueri berikutnya. |
addGroupMember
Untuk memanggil metode ini, Anda harus memiliki izin administrator atau menjadi administrator grup.
Menambahkan pengguna ke grup sebagai anggota.
const result = await client.addGroupMember(params, options)Kode contoh
await client.addGroupMember({
member_id: 'test',
member_type: 'user',
group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | IAddGroupMemberReq | Ya | Parameter permintaan. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
IAddGroupMemberReq
Parameter | Tipe | Diperlukan | Deskripsi |
group_id | string | Ya | ID grup. |
member_id | string | Ya | ID pengguna. |
member_type | string | Ya | Tipe anggota. Atur nilai ke user. Untuk membuat grup anak, panggil metode createGroup. |
Parameter respons
Tidak ada.
removeGroupMember
Untuk memanggil metode ini, Anda harus memiliki izin administrator atau menjadi administrator grup.
Menghapus anggota dari grup.
await client.removeGroupMember(params, options)Kode contoh
await client.removeGroupMember({
member_id: 'test',
member_type: 'user',
group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | IRemoveGroupMemberReq | Ya | Parameter permintaan. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
IRemoveGroupMemberReq
Parameter | Tipe | Diperlukan | Deskripsi |
group_id | string | Ya | ID grup. |
member_id | string | Ya | ID pengguna. |
member_type | string | Ya | Tipe anggota. Anda hanya dapat menghapus pengguna dari grup. Untuk menghapus grup anak, panggil metode deleteGroup.
|
Parameter respons
Tidak ada.