Administrator perusahaan dapat memanggil API ini untuk membuat token akses bagi pengguna tertentu.
Edition yang didukung | Edition Enterprise Khusus |
Titik akhir layanan dan informasi otorisasi
Dapatkan titik akhir layanan untuk mengganti <domain> dalam sintaks permintaan API dengan titik akhir Anda.
Dapatkan token akses.
Dapatkan
organizationId. Buka konsol Lingma dan lihat ID organisasi pada halaman Basic Information di bawah .
Produk | Sumber daya | Izin yang diperlukan |
Pengaturan Organisasi | Pengguna | Baca dan tulis |
Sintaks permintaan
POST https://{domain}/oapi/v1/platform/users/admin/personalAccessTokensHeader permintaan
Parameter | Tipe | Diperlukan | Deskripsi | Contoh |
| string | Ya | Token akses. | pt-0fh3****0fbG_35af****0484 |
Parameter permintaan
Parameter | Tipe | Posisi | Diperlukan | Deskripsi | Contoh |
- | object | body | Tidak | ||
| string | body | Tidak | Deskripsi dari token akses. | Contoh deskripsi token |
| string | body | Ya | Tanggal dan waktu ketika token akses kedaluwarsa. | 2023-03-22T12:44:50.048Z |
| string | body | Ya | Nama dari token akses. | Contoh nama token |
| array[string] | body | Ya | Daftar izin yang diberikan kepada pengguna oleh token akses. Lihat Edition Enterprise Khusus untuk detailnya. | ["base_user_read"] |
| string | body | Ya | ID pengguna unik. | 3001****-****-4229-a7f2-********41ad |
Contoh permintaan
curl -X 'POST' \
'https://{domain}/oapi/v1/platform/users/admin/personalAccessTokens' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
--data '
{
"description": "Contoh deskripsi token",
"expiredAt": "2023-03-22T12:44:50.048Z",
"name": "Contoh nama token",
"permissions": ["base_user_read"],
"userId": "3001****-****-4229-a7f2-********41ad"
}'Parameter respons
Parameter | Tipe | Deskripsi | Contoh |
- | object | ||
| string | Tanggal dan waktu ketika token akses dibuat. | 2023-03-22T12:44:50.048Z |
| string | Deskripsi dari token akses. | Contoh deskripsi token |
| string | Tanggal dan waktu ketika token akses kedaluwarsa. | 2023-03-22T12:44:50.048Z |
| string | Nama dari token akses. | Contoh nama token |
| array[string] | Daftar izin yang diberikan kepada pengguna oleh token akses. | ["base_user_read"] |
| string | Token akses. | pt-0fh30fbG_35af0484 |
| string | ID token akses unik. | 0fh3****0fbG |
| string | ID pengguna unik. | 3001****-****-4229-a7f2-********41ad |
Contoh respons
{
"createdAt": "2023-03-22T12:44:50.048Z",
"description": "Contoh deskripsi token",
"expiredAt": "2023-03-22T12:44:50.048Z",
"name": "Contoh nama token",
"permissions": ["base_user_read"],
"token": "pt-0fh3****0fbG_35af****0484",
"tokenId": "0fh3****0fbG",
"userId": "3001****-****-4229-a7f2-********41ad"
}Kode kesalahan
Untuk informasi lebih lanjut, lihat Kode Kesalahan.