Setiap pengguna memiliki ID unik dalam domain. Akun digunakan oleh pengguna untuk masuk, dan satu pengguna dapat memiliki beberapa akun masuk seperti nomor ponsel dan alamat email.
Peran yang telah ditentukan sebelumnya oleh sistem meliputi pengguna, admin, dan superadmin.
Izin admin yang disebutkan dalam dokumen ini mengacu pada izin dari pengguna dengan peran admin atau superadmin.
Parameter options dari tipe IPDSRequestConfig dienkapsulasi berdasarkan opsi konfigurasi permintaan axios. Untuk informasi lebih lanjut, lihat AxiosRequestConfig.
Metode createUser
Untuk menggunakan metode ini, Anda harus memiliki izin admin.
Membuat pengguna baru.
Metode ini hanya digunakan untuk membuat pengguna. Jika Anda ingin menggunakan metode masuk yang disediakan oleh Drive and Photo Service (PDS), Anda harus memanggil operasi LinkAccount.
Jika Anda mengakses Drive and Photo Service (PDS) menggunakan autentikasi JSON Web Token (JWT), Anda tidak perlu memanggil operasi LinkAccount.
const result = await client.createUser(params, options)Contoh
const userInfo = await client.createUser({
user_id: 'id_123',
phone: '135****8888',
email:'username@aliyundoc.com',
nick_name: 'Nama Panggilan',
user_name: 'Nama Pengguna',
role: 'user'
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | ICreateUserReq | Ya | Parameter permintaan yang digunakan untuk membuat pengguna. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
ICreateUserReq parameter
Parameter | Tipe | Diperlukan | Deskripsi |
user_id | string | Ya | ID pengguna. |
role | string | Peran pengguna. Nilai valid: user, admin, superadmin, subdomain, subdomain_super_admin, dan subdomain_admin. Nilai default: user. Jika Anda membuat pengguna di domain saat ini, Anda dapat menetapkan parameter ini ke subdomain. | |
user_name | string | Nama pengguna. | |
nick_name | string | Nama panggilan pengguna. | |
description | string | Deskripsi pengguna. | |
string | Alamat email pengguna. | ||
phone | string | Nomor ponsel pengguna. | |
status | string | Status pengguna. Nilai valid: disabled dan enabled. | |
avatar | string | Foto profil pengguna. Nilainya harus URI yang dimulai dengan http:// atau dienkripsi dalam Base64. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IUserItem | Ya | Hasil yang dikembalikan. |
IUserItem parameter
Parameter | Tipe | Deskripsi |
domain_id | string | ID domain. |
user_id | string | ID pengguna. |
string | Alamat email pengguna. | |
role | string | Peran pengguna. |
description | string | Deskripsi pengguna. |
phone | string | Nomor ponsel pengguna. |
nick_name | string | Nama panggilan pengguna. |
user_name | string | Nama pengguna. |
status | string | Status pengguna. Nilai valid: enabled dan disabled. |
avatar | string | Foto profil pengguna. |
created_at | number | Waktu pembuatan pengguna. Nilai ini adalah timestamp UNIX yang mewakili jumlah milidetik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC. |
updated_at | number | Waktu terakhir informasi pengguna dimodifikasi. Nilai ini adalah timestamp UNIX yang mewakili jumlah milidetik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC. |
default_drive_id | string | ID drive default. |
Metode listUsers
Untuk menggunakan metode ini, Anda harus memiliki izin admin.
Meminta daftar pengguna.
const result = await client.listUsers(params, options)Contoh:
const {items=[],next_marker} = await client.listUsers({
limit: 100,
marker: ''
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | IListReq | Parameter permintaan yang digunakan untuk meminta daftar pengguna. Jika Anda tidak menentukan parameter ini, nilai default {} digunakan. | |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
IListReq parameter
Parameter | Tipe | Diperlukan | Deskripsi |
marker | string | Penanda awal dari permintaan. | |
limit | string | Jumlah maksimum entri yang akan dikembalikan. Nilai valid: 1 hingga 100. Nilai default: 100. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IListRes | Ya | Hasil yang dikembalikan. |
IListRes parameter
Parameter | Tipe | Diperlukan | Deskripsi |
items | IUserItem[] | Ya | Daftar pengguna. |
Metode getUser
Jika Anda memiliki izin admin, Anda dapat meminta informasi tentang semua pengguna. Jika tidak, Anda hanya dapat meminta informasi tentang pengguna saat ini.
Meminta informasi pengguna.
const result = await client.getUser(params, options)Contoh
const userInfo = await client.getUser({
user_id: 'id_123'
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | Object | Ya | Parameter permintaan yang digunakan untuk meminta informasi pengguna. Jika Anda tidak menentukan parameter ini, nilai default {} digunakan. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
params parameter
Parameter | Tipe | Diperlukan | Deskripsi |
user_id | string | Ya | ID pengguna. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IUserItem | Ya | Hasil yang dikembalikan. |
IUserItem parameter
Parameter | Tipe | Deskripsi |
domain_id | string | ID domain. |
user_id | string | ID pengguna. |
string | Alamat email pengguna. | |
role | string | Peran pengguna. |
description | string | Deskripsi pengguna. |
phone | string | Nomor ponsel pengguna. |
nick_name | string | Nama panggilan pengguna. |
user_name | string | Nama pengguna. |
status | string | Status pengguna. Nilai valid: enabled dan disabled. |
avatar | string | Foto profil pengguna. |
created_at | number | Waktu pembuatan pengguna. Nilai ini adalah timestamp UNIX yang mewakili jumlah milidetik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC. |
updated_at | number | Waktu terakhir informasi pengguna dimodifikasi. Nilai ini adalah timestamp UNIX yang mewakili jumlah milidetik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC. |
default_drive_id | string | ID drive default. |
Metode generalGetUser
Meminta pengguna tertentu.
const result = await client.generalGetUser(params, options)Contoh
const userInfo = await client.generalGetUser({
user_id: 'id_123',
extra_return_info: ['drive', 'group']
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | Object | Ya | Parameter permintaan yang digunakan untuk meminta pengguna tertentu. Jika Anda tidak menentukan parameter ini, nilai default {} digunakan. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
params parameter
Parameter | Tipe | Diperlukan | Deskripsi |
user_id | string | Ya | ID pengguna. Jika Anda tidak menentukan parameter ini, pengguna saat ini yang akan diminta. |
extra_return_info | string[] | Jenis informasi pengguna yang ingin diminta. Nilai valid: drive dan group. Parameter ini hanya valid jika Anda memiliki izin admin. Jika Anda menetapkan parameter ini ke group, kecepatan permintaan akan berkurang secara signifikan. Dalam hal ini, jumlah permintaan tidak boleh melebihi 30. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IUserItem | Ya | Hasil yang dikembalikan. |
IUserItem parameter
Parameter | Tipe | Deskripsi |
domain_id | string | ID domain. |
user_id | string | ID pengguna. |
string | Alamat email pengguna. | |
role | string | Peran pengguna. |
description | string | Deskripsi pengguna. |
phone | string | Nomor ponsel pengguna. |
nick_name | string | Nama panggilan pengguna. |
user_name | string | Nama pengguna. |
status | string | Status pengguna. Nilai valid: enabled dan disabled. |
avatar | string | Foto profil pengguna. |
created_at | number | Waktu pembuatan pengguna. Nilai ini adalah timestamp UNIX yang mewakili jumlah milidetik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC. |
updated_at | number | Waktu terakhir informasi pengguna dimodifikasi. Nilai ini adalah timestamp UNIX yang mewakili jumlah milidetik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC. |
default_drive_id | string | ID drive default. |
Metode updateUser
Untuk menggunakan metode ini, Anda harus memiliki izin admin.
Memodifikasi informasi pengguna seperti nama panggilan dan foto profil.
await client.updateUser(params, options)Contoh
// Menonaktifkan pengguna.
await client.updateUser({
user_id: 'id_123',
status : 'disabled'
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | IUpdateUserReq | Ya | Parameter permintaan yang digunakan untuk memodifikasi informasi pengguna. Jika Anda tidak menentukan parameter ini, nilai default {} digunakan. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
IUpdateUserReq parameter
Parameter | Tipe | Diperlukan | Deskripsi |
user_id | string | Ya | ID pengguna. |
role | string | Peran pengguna. Nilai valid: user, admin, dan superadmin. Nilai default: user. | |
nick_name | string | Nama panggilan pengguna. | |
description | string | Deskripsi pengguna. | |
string | Alamat email pengguna. | ||
phone | string | Nomor ponsel pengguna. | |
status | string | Status pengguna. Nilai valid: disabled dan enabled. | |
avatar | string | Foto profil pengguna. Nilainya harus URI yang dimulai dengan http:// atau dienkripsi dalam Base64. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IUserItem | Ya | Hasil yang dikembalikan. |
Metode deleteUser
Untuk menggunakan metode ini, Anda harus memiliki izin admin.
Menghapus pengguna beserta akun terkait.
await client.deleteUser(params, options)Contoh
await client.deleteUser({
user_id: 'id_123'
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | Object | Ya | Parameter permintaan yang digunakan untuk menghapus pengguna dan akun yang terkait dengan pengguna tersebut. Jika Anda tidak menentukan parameter ini, nilai default {} digunakan. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
params parameter
Parameter | Tipe | Diperlukan | Deskripsi |
user_id | string | Ya | ID pengguna. |
Parameter respons
Tidak ada.
Metode searchUsers
Untuk menggunakan metode ini, Anda harus memiliki izin admin.
Mencari pengguna.
const result = await client.searchUsers(params, options)Contoh
const {items=[]} = await client.searchUsers({
nick_name_for_fuzzy: 'test'
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | ISearchUsersReq | Ya | Parameter permintaan yang digunakan untuk mencari pengguna. Jika Anda tidak menentukan parameter ini, nilai default {} digunakan. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
ISearchUsersReq parameter
Parameter | Tipe | Diperlukan | Deskripsi |
nick_name | string | Nama panggilan pengguna. Cocokan awalan didukung. | |
nick_name_for_fuzzy | string | Nama panggilan pengguna untuk pencarian fuzzy. | |
user_name | string | Nama pengguna. Cocokan awalan didukung. | |
string | Alamat email pengguna. Cocokan awalan didukung. | ||
phone | string | Nomor ponsel pengguna. Cocokan awalan didukung. | |
role | string | Peran pengguna. Pencocokan tepat digunakan. | |
status | string | Status pengguna. Pencocokan tepat digunakan. | |
limit | number | Jumlah maksimum entri yang akan dikembalikan. Nilai valid: 1 hingga 100. Nilai default: 100. | |
marker | string | Penanda awal dari permintaan. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IListRes | Ya | Hasil yang dikembalikan. |
IListRes parameter
Parameter | Tipe | Deskripsi |
items | IUserItem[] | Pengguna yang dikembalikan. |
next_marker | string | Token paginasi. Dapat digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. |
Metode generalSearchUsers
Mencari pengguna dalam grup.
const result = await client.generalSearchUsers(params, options)Contoh
const {items=[], next_marker} = await client.generalSearchUsers({
nick_name_for_fuzzy: 'test',
direct_parent_group_id: '123456',
extra_return_info: ['drive', 'group'],
limit: 30,
marker: ''
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | IUserGeneralSearchReq | Ya | Parameter permintaan yang digunakan untuk mencari pengguna dalam grup. Jika Anda tidak menentukan parameter ini, nilai default {} digunakan. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
IUserGeneralSearchReq parameter
Parameter | Tipe | Diperlukan | Deskripsi |
nick_name | string | Nama panggilan pengguna. Cocokan awalan didukung. | |
nick_name_for_fuzzy | string | Nama panggilan pengguna untuk pencarian fuzzy. | |
parent_group_id_list | string[] | Grup yang pengguna langsung dan pengguna subgrup ingin Anda cari. | |
direct_parent_group_id | string | Grup yang pengguna langsung ingin Anda cari. | |
extra_return_info | string[] | Jenis informasi pengguna yang ingin diminta. Nilai valid: drive dan group. Parameter ini hanya valid jika Anda memiliki izin admin. Jika Anda menetapkan parameter ini ke group, kecepatan permintaan akan berkurang secara signifikan. Dalam hal ini, jumlah permintaan tidak boleh melebihi 30. | |
limit | number | Jumlah maksimum entri yang akan dikembalikan. Nilai valid: 1 hingga 100. Nilai default: 100. | |
marker | string | Penanda awal dari permintaan. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IListRes | Ya | Hasil yang dikembalikan. |
IListRes parameter
Parameter | Tipe | Deskripsi |
items | IUserItem[] | Pengguna yang dikembalikan. |
next_marker | string | Token paginasi. Dapat digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. |
Metode listGroupUsers
Meminta anggota langsung dari sebuah grup.
Baik administrator maupun pengguna biasa dapat menggunakan metode ini.
const result = await client.listGroupUsers(params, options)Contoh
const params = {
group_id: "abc"
}
const {items=[], next_marker} = await client.listGroupUsers(params)Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | IListGroupUserReq | Ya | Parameter permintaan yang digunakan untuk meminta anggota langsung dari sebuah grup. Jika Anda tidak menentukan parameter ini, nilai default {} digunakan. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
IListGroupUserReq parameter
Parameter | Tipe | Diperlukan | Deskripsi |
group_id | string | ID grup yang ingin Anda cari. | |
member_type | string | Jenis anggota grup yang ingin Anda cari. Nilai valid: user dan group. Jika Anda tidak menentukan parameter ini, pengguna langsung dan subgrup dari grup tersebut akan dicari. | |
extra_return_info | string[] | Jenis informasi pengguna yang ingin diminta. Nilai valid: group dan drive. Parameter ini hanya valid jika Anda memiliki izin admin. Jika Anda menetapkan parameter ini ke group, kecepatan permintaan akan berkurang secara signifikan. Dalam hal ini, jumlah permintaan tidak boleh melebihi 30. | |
limit | number | Jumlah maksimum entri yang akan dikembalikan. Nilai valid: 1 hingga 100. Nilai default: 100. | |
marker | string | Penanda awal dari permintaan. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IListRes | Ya | Hasil yang dikembalikan. |
IListRes parameter
Parameter | Tipe | Deskripsi |
items | IGroupItem[] atau IUserItem[] | Anggota yang dikembalikan. |
next_marker | string | Token paginasi. Dapat digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. |
Metode importUser
Untuk menggunakan metode ini, Anda harus memiliki izin admin.
Mengimpor pengguna yang menggunakan nomor ponsel atau alamat email untuk masuk.
Cara alternatif untuk melakukan operasi ini adalah dengan memanggil operasi createUser terlebih dahulu dan kemudian memanggil operasi createAccountLink setelah pemanggilan pertama berhasil.
const result = await client.importUser(params, options)Contoh
Kode contoh berikut menunjukkan cara mengimpor pengguna yang menggunakan nomor ponsel untuk masuk:
await client.importUser({
authentication_type: 'mobile',
auto_create_drive: true,
identity:'135****8888',
drive_total_size: 1024 * 1024 * 1024,
nick_name: 'W123'
})Kode contoh berikut menunjukkan cara mengimpor pengguna yang menggunakan alamat email untuk masuk:
await client.importUser({
authentication_type: 'email',
auto_create_drive: true,
identity:'username@example.com',
drive_total_size: 1024 * 1024 * 1024,
nick_name: 'W123'
})Parameter permintaan
Parameter | Tipe | Diperlukan | Deskripsi |
params | IImportUserReq | Ya | Parameter permintaan yang digunakan untuk mengimpor pengguna. Jika Anda tidak menentukan parameter ini, nilai default {} digunakan. |
options | IPDSRequestConfig | Parameter permintaan lainnya. |
IImportUserReq parameter
Parameter | Tipe | Diperlukan | Deskripsi |
auto_create_drive | boolean | Menentukan apakah akan membuat drive secara otomatis. | |
drive_total_size | number | Total ukuran drive. | |
authentication_type | string | Jenis autentikasi masuk. Nilai valid: mobile, email, ldap, dan custom. | |
identity | string | Ya | Pengenal unik pengguna. Jika Anda menetapkan parameter authentication_type ke mobile, Anda harus menetapkan parameter ini ke nomor ponsel pengguna. Jika Anda menetapkan parameter authentication_type ke email, Anda harus menetapkan parameter ini ke alamat email pengguna. Jika Anda menetapkan parameter authentication_type ke ldap, Anda harus menetapkan parameter ini ke akun LDAP pengguna. Jika Anda menetapkan parameter authentication_type ke custom, Anda harus menetapkan parameter ini ke ID kustom. |
parent_group_id | string | ||
nick_name | string | Nama panggilan pengguna. |
Parameter respons
Parameter | Tipe | Diperlukan | Deskripsi |
result | IUserItem | Ya | Hasil yang dikembalikan. |