ListMembers API - Kueri anggota organisasi | Lingma - Seri Qoder CN

Menanyakan daftar anggota organisasi.

Penting

Situs dokumentasi Qoder CN yang baru kini telah tersedia. Konten di situs ini mungkin tidak mencerminkan fitur dan perubahan Produk terbaru. Kunjungi docs.qoder.cn untuk dokumentasi Produk terbaru.

Versi yang berlaku

Enterprise Dedicated Edition

Titik akhir layanan dan otorisasi

Ganti <domain> dalam sintaks permintaan API dengan endpoint layanan Anda.
Dapatkan access token.
Dapatkan organizationId. Buka Konsol Lingma, lalu lihat ID organisasi pada halaman Basic Information di bawah Enterprise settings > Organization.

Produk

Resource

Izin yang diperlukan

Manajemen Penyewa

Organization members

Read-only

Sintaks permintaan

GET https://{domain}/oapi/v1/platform/organizations/{organizationId}/members

Header permintaan

Parameter	Tipe	Wajib	Deskripsi	Nilai contoh
x-yunxiao-token	string	Ya	Personal access token.	pt-0fh3**0fbG_35af**0484

Parameter permintaan

Parameter	Tipe	Posisi	Wajib	Deskripsi	Nilai contoh
organizationId	string	path	Ya	Organization ID.	99d1****71d4
page	integer	query	Tidak	Nomor halaman. Default: 1.	1
perPage	integer	query	Tidak	Jumlah entri per halaman. Default: 100.	100

Contoh permintaan

curl -X 'GET' \
  'https://{domain}/oapi/v1/platform/organizations/{organizationId}/members?page={page}&perPage={perPage}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Parameter respons

Parameter	Tipe	Deskripsi	Nilai contoh
-	array
-	object
deptIds	array[string]	Departemen tempat anggota tersebut terdaftar.	["99d1****6124"]
id	string	Member ID.	99d1****6124
joined	string	Waktu saat anggota bergabung. Setara dengan waktu pembuatan database.	2023-08-31T03:59:16.201Z
name	string	Nama anggota.	Example Name
organizationId	string	Organization ID.	99d1****6124
roleIds	array[string]	ID role yang ditetapkan kepada anggota tersebut.	["99d1****6124"]
status	string	Status anggota. Nilai yang valid: ENABLED, DISABLED, UNDELETED, DELETED, NORMAL_USING, UNVISITED.	ENABLED
userId	string	User ID.	99d1****6124
visited	string	Waktu kunjungan terakhir.	2023-08-31T03:59:16.201Z

Contoh respons

[
    {
        "deptIds": ["99d1****6124"],
        "id": "99d1****6124",
        "joined": "2023-08-31T03:59:16.201Z",
        "name": "Example Name",
        "organizationId": "99d1****6124",
        "roleIds": ["99d1****6124"],
        "status": "ENABLED",
        "userId": "99d1****6124",
        "visited": "2023-08-31T03:59:16.201Z"
    }
]

Header respons

Parameter	Deskripsi	Nilai contoh
x-next-page	Nomor halaman berikutnya.	1
x-page	Nomor halaman saat ini.	2
x-per-page	Jumlah entri per halaman.	1
x-prev-page	Nomor halaman sebelumnya.	2
x-total	Total entri.	1
x-total-pages	Total halaman.	3

Kode error

Untuk informasi lebih lanjut, lihat Error code center.

Produk	Resource	Izin yang diperlukan
Manajemen Penyewa	Organization members	Read-only