Ambil data pengguna terhalaman melalui API ListUsers - Lingma

Edisi yang didukung

Enterprise Dedicated Edition

Titik akhir layanan

Dapatkan titik akhir layanan dan ganti {domain} dalam sintaks permintaan API dengan endpoint Anda.

Produk	Sumber daya	Izin yang diperlukan
organization management	User	Hanya baca

GET https://{domain}/oapi/v1/platform/users?filter={filter}&status={status}&deptId={deptId}&page={page}&perPage={perPage}

Detail permintaan	Pengguna aktif `curl -X 'GET' \ 'https://test-domain-*.rdc.aliyuncs.com/oapi/v1/platform/users' \ -H 'Content-Type: application/json' \ -H 'x-yunxiao-token: pt-0fh30fbG_35af0484'` Pengguna yang dihapus `curl -X 'GET' \ 'https://test-domain-.rdc.aliyuncs.com/oapi/v1/platform/users?status=deleted' \ -H 'Content-Type: application/json' \ -H 'x-yunxiao-token: pt-0fh3*0fbG_35af**0484'`
Header permintaan
`x-yunxiao-token` `string` (Wajib) Token akses. Lihat Access token untuk detailnya. Contoh: pt-0fh3**0fbG_35af**0484.
Parameter permintaan
filter `string` (Opsional) Kata kunci untuk pencarian fuzzy pada username, nama login, alamat email, atau nomor telepon.
status `string` (Opsional) Memfilter pengguna berdasarkan status mereka. `enabled`: Mengembalikan pengguna aktif. `deleted`: Mengembalikan pengguna yang dihapus.
deptId `string` (Opsional) Memfilter pengguna berdasarkan ID departemen.
page `integer` (Opsional) Nilai default: `1` Nomor halaman yang akan dikembalikan.
perPage `integer` (Opsional) Nilai default: `100` Jumlah entri yang dikembalikan per halaman. Nilainya harus berada dalam rentang `[1, 100]`.

Parameter respons	Pengguna aktif `[ { "id": "c75d6f21-2af7-4d8e-b0fb-bac25128**", "username": "tmp_test2", "name": "Test User 2", "sysDeptIds": [ "9e415b19-10bc-4bb6-a34f-2045a59a" ], "lastOrganization": "3deba052-8501-4f30-a52d-3e9b1ca8", "createdAt": "2025-06-10T06:45:29Z" }, { "id": "85c7aa62-8da7-4f2d-8c99-4b90a253", "username": "tmp_test1", "name": "Test User 1", "sysDeptIds": [ "9e415b19-10bc-4bb6-a34f-2045a59a" ], "createdAt": "2025-06-10T06:44:57Z" } ]` Pengguna yang dihapus `[ { "id": "3d4caf00-0004-4a07-9cb7-18c9559d", "username": "doc-test4", "name": "Doc Test User 4", "nickName": "Nickname 4", "email": "doc-test4@example.com", "staffId": "1004", "sysDeptIds": [ "ebeb5a64-c98c-478a-9d9d-513841da**" ], "createdAt": "2025-06-13T05:41:53Z", "deletedAt": "2025-06-13T06:36:43Z" } ]`
id `string` ID unik pengguna.
username `string` Nama login pengguna.
name `string` Nama tampilan pengguna.
nickName `string` Nama panggilan pengguna.
email `string` Alamat email pengguna.
lastOrganization `string` ID organisasi tempat pengguna terakhir kali masuk.
staffId `string` ID karyawan pengguna.
sysDeptIds `array[string]` ID departemen tempat pengguna tergabung.
createdAt `string` Waktu saat pengguna dibuat.
deletedAt `string` Waktu saat pengguna dihapus. Parameter ini hanya dikembalikan untuk pengguna yang dihapus.

Untuk informasi lebih lanjut, lihat Error codes.