All Products
Search

This Product

    Elastic Desktop Service:GetLoginToken

    Document Center

    Elastic Desktop Service:GetLoginToken

    Last Updated:Oct 28, 2026

    Mengambil kredensial logon.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    ID wilayah. Anda dapat memanggil operasi DescribeRegions untuk mengkueri wilayah yang didukung oleh Elastic Desktop Service.

    cn-hangzhou
    ClientId

    string

    Yes

    ID unik yang dihasilkan oleh Klien.

    f4a0dc8e-1702-4728-9a60-95b27a35****
    DirectoryId

    string

    No

    ID ruang kerja. Parameter ini memiliki makna yang sama dengan OfficeSiteId. Kami menyarankan Anda menggunakan OfficeSiteId alih-alih DirectoryId. Anda hanya dapat menentukan salah satu dari DirectoryId dan OfficeSiteId.

    cn-hangzhou+dir-885351****
    OfficeSiteId

    string

    No

    ID ruang kerja.

    cn-hangzhou+dir-885351****
    SessionId

    string

    No

    ID sesi untuk logon.

    • Jika tidak ada perangkat MFA virtual yang disambungkan atau otentikasi sekunder sisi Klien tidak diaktifkan, Anda tidak perlu menentukan SessionId.

    • Jika perangkat MFA virtual disambungkan atau otentikasi sekunder sisi Klien diaktifkan, Anda harus menentukan SessionId pada tahap otentikasi logon setelah ADPassword. Anda dapat memperoleh SessionId dari tanggapan verifikasi akun kemudahan (saat permintaan GetLoginToken berada pada tahap ADPassword).

    cd45e873-650d-4d70-acb9-f996187a****
    CurrentStage

    string

    No

    Tahap otentikasi logon saat ini. Nilai valid:

    • ADPassword: memverifikasi informasi pengguna. Tentukan nilai ini saat otentikasi berbasis kata sandi digunakan untuk akun kemudahan atau akun Direktori Aktif (AD).

    • MFABind: menyambungkan perangkat MFA virtual.

    • MFAVerify: memverifikasi kode keamanan yang dihasilkan oleh perangkat MFA virtual.

    • TokenVerify: melakukan otentikasi sekunder sisi klien.

    • ChangePassword: mengubah kata sandi pengguna.

    • KeepAliveVerify: menukar KeepAliveToken yang valid dengan LoginToken.

    ADPassword
    EndUserId

    string

    No

    Nama pengguna pengguna kemudahan atau pengguna AD. Parameter ini wajib diisi saat CurrentStage diatur ke ADPassword.

    alice
    Password

    string

    No

    Kata sandi pengguna kemudahan atau pengguna AD. Parameter ini wajib diisi saat CurrentStage diatur ke ADPassword.

    Password1234
    OldPassword

    string

    No

    Kata sandi lama. Parameter ini wajib diisi saat CurrentStage diatur ke ChangePassword.

    OldPassword
    NewPassword

    string

    No

    Kata sandi baru. Parameter ini wajib diisi saat CurrentStage diatur ke ChangePassword.

    NewPassword
    AuthenticationCode

    string

    No

    Kode keamanan yang dihasilkan oleh perangkat MFA virtual. Parameter ini wajib diisi saat CurrentStage diatur ke MFAVerify.

    47****
    ClientOS

    string

    No

    Sistem operasi Perangkat tempat Klien berjalan.

    Windows_NT 10.0.18363 x64
    ClientVersion

    string

    No

    Versi klien. Jika Anda menggunakan klien Wuying, Anda dapat melihat parameter ini di kotak dialog About pada halaman logon klien.

    2.1.0-R-20210731.151756
    TokenCode

    string

    No

    Kode verifikasi untuk otentikasi sekunder. Jika otentikasi sekunder sisi Klien diaktifkan di Konsol Elastic Desktop Service dan pengguna logon saat ini diidentifikasi berisiko, kode verifikasi dikirim ke alamat email pengguna akhir. Parameter ini wajib diisi saat CurrentStage diatur ke TokenVerify.

    63****
    KeepAlive

    boolean

    No

    Apakah akan mempertahankan pengguna tetap logon.

    Valid values:

    • null :

      null: Tidak mempertahankan pengguna tetap logon. Nilai default.

    • false :

      false: Tidak mempertahankan pengguna tetap logon.

    • true :

      true: Mempertahankan pengguna tetap logon.

    false
    KeepAliveToken

    string

    No

    Token yang digunakan untuk mempertahankan pengguna tetap logon. Setelah logon berhasil dan jika pengguna mengaktifkan opsi tetap logon, API akan mengembalikan KeepAliveToken. Dalam periode validitas KeepAliveToken, Anda dapat memanggil operasi GetLoginToken dan mengatur CurrentStage ke KeepAliveVerify untuk menukarnya dengan token logon (LoginToken). Parameter ini wajib diisi saat CurrentStage diatur ke KeepAliveVerify.

    hide
    Uuid

    string

    No

    Pengenal unik klien. Jika Anda menggunakan klien Wuying, Anda dapat melihat parameter ini di kotak dialog About pada halaman logon klien.

    C78CA9E99315687575DD2844C1F3****
    ClientType

    string

    No

    Tipe Klien perangkat lunak Wuying.

    Valid values:

    • HTML5 :

      HTML5: Klien web.

    • MACOS :

      MACOS: Klien macOS.

    • WINDOWS :

      WINDOWS: Klien Windows.

    • ANDROID :

      ANDROID: Klien Android.

    • IOS :

      IOS: Klien iOS.

    WINDOWS
    AvailableFeatures

    object

    No

    Fitur yang didukung oleh Klien.

    string

    No

    Fitur yang didukung oleh Klien.

    1
    ClientName

    string

    No

    Nama Klien.

    demo-client

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Informasi tanggapan.

    Email

    string

    Alamat email pengguna. Parameter ini dikembalikan bersama LoginToken setelah logon.

    • Untuk pengguna kemudahan, alamat email yang ditentukan saat pengguna kemudahan dibuat akan dikembalikan.

    • Untuk pengguna AD, alamat email dikembalikan dalam format berikut: Nama pengguna@Nama domain AD.

    alice
    Secret

    string

    Kunci rahasia yang digunakan untuk menyambungkan perangkat MFA virtual. Digunakan pada tahap MFABind.

    Catatan

    Untuk informasi lebih lanjut mengenai setiap tahap otentikasi, lihat deskripsi data deret waktu dari parameter permintaan CurrentStage.

    5OCLLKKOJU5HPBX66H3QCTWYI7MH****
    RequestId

    string

    ID permintaan.

    1CBAFFAB-B697-4049-A9B1-67E1FC5F****
    EndUserId

    string

    Nama pengguna akun kemudahan atau pengguna AD.

    alice
    LoginToken

    string

    Token logon.

    v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
    NextStage

    string

    Tahap berikutnya yang diharapkan. Misalnya, jika administrator mengaktifkan otentikasi MFA di Konsol Elastic Desktop Service, parameter ini mengembalikan MFAVerify setelah otentikasi nama pengguna dan kata sandi berhasil (yaitu, setelah tahap ADPassword). Ini menunjukkan bahwa otentikasi MFA diperlukan.

    Catatan

    Untuk informasi lebih lanjut mengenai setiap tahap otentikasi, lihat deskripsi data deret waktu dari parameter permintaan CurrentStage.

    MFAVerify
    QrCodePng

    string

    Kode QR dari kunci rahasia yang digunakan untuk menyambungkan perangkat MFA virtual. Menggunakan pengodean Base64. Parameter ini dapat kosong dan digunakan pada tahap MFABind.

    Catatan

    Untuk informasi lebih lanjut mengenai setiap tahap otentikasi, lihat deskripsi data deret waktu dari parameter permintaan CurrentStage.

    5OCLLKKOJU5HPBX66H3QCTWY******
    Label

    string

    Properti pengguna kemudahan. Jika pengguna adalah pengguna AD, nilai kosong akan dikembalikan.

    test:wuying
    SessionId

    string

    ID sesi. Parameter ini hanya dikembalikan saat GetLoginToken dipanggil untuk pertama kalinya dalam sesi yang sama. Jika beberapa langkah otentikasi diperlukan, Anda harus meneruskan parameter ini pada tahap berikutnya.

    Catatan

    Untuk informasi lebih lanjut mengenai setiap tahap otentikasi, lihat deskripsi data deret waktu dari parameter permintaan CurrentStage.

    d6ec166d-ab93-4286-bf7f-a18bb929****
    Phone

    string

    Nomor telepon seluler pengguna kemudahan. Jika pengguna adalah pengguna AD, nilai kosong akan dikembalikan.

    1381111****
    TenantId

    integer

    ID akun Alibaba Cloud. Parameter ini digunakan untuk identifikasi terminal perangkat keras.

    166353906220****
    KeepAliveToken

    string

    Token yang digunakan untuk mempertahankan pengguna tetap logon. Setelah logon berhasil dan jika pengguna mengaktifkan opsi tetap logon, API akan mengembalikan KeepAliveToken. Jika opsi tetap logon tidak diaktifkan, nilai kosong akan dikembalikan.

    006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW
    Industry

    string
    Catatan

    Bidang pribadi internal. Tidak tersedia untuk penggunaan eksternal.

    edu
    Props

    object
    Catatan

    Bidang pribadi internal. Tidak tersedia untuk penggunaan eksternal.

    string
    Catatan

    Bidang pribadi internal. Tidak tersedia untuk penggunaan eksternal.

    {'dingUserName': u'\u674e\u66fc', 'role': 'student'}
    WindowDisplayMode

    string
    Catatan

    Bidang pribadi internal. Tidak tersedia untuk penggunaan eksternal.

    mode
    RiskVerifyInfo

    object

    Informasi identifikasi risiko logon.

    Email

    string

    Alamat email yang digunakan untuk verifikasi saat verifikasi identitas dipicu.

    user@example.com
    LastLockDuration

    integer

    Durasi penguncian akun.

    1713749778
    Locked

    string

    Apakah akun terkunci.

    Valid values:

    • false :

      false: Tidak.

    • true :

      true: Ya.

    true
    Phone

    string

    Nomor telepon seluler yang digunakan untuk verifikasi saat verifikasi identitas dipicu.

    1381111****
    Reason

    string
    Catatan

    Bidang pribadi internal. Tidak tersedia untuk penggunaan eksternal.

    null
    PasswordStrategy

    object
    Catatan

    Bidang pribadi internal. Tidak tersedia untuk penggunaan eksternal.

    TenantPasswordLength

    string
    Catatan

    Bidang pribadi internal. Tidak tersedia untuk penggunaan eksternal.

    null
    TenantAlternativeChars

    array
    Catatan

    Bidang pribadi internal. Tidak tersedia untuk penggunaan eksternal.

    string
    Catatan

    Bidang pribadi internal. Tidak tersedia untuk penggunaan eksternal.

    null
    NickName

    string

    Nama panggilan pengguna.

    user-001
    WyId

    string

    0123456789abcdef
    OfficeSiteId

    string

    ID ruang kerja.

    cn-hangzhou+dir-885351****
    OfficeSiteName

    string

    Nama ruang kerja.

    test

    Contoh

    Respons sukses

    JSONformat

    {
  "Email": "alice",
  "Secret": "5OCLLKKOJU5HPBX66H3QCTWYI7MH****",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "EndUserId": "alice",
  "LoginToken": "v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****",
  "NextStage": "MFAVerify",
  "QrCodePng": "5OCLLKKOJU5HPBX66H3QCTWY******",
  "Label": "test:wuying",
  "SessionId": "d6ec166d-ab93-4286-bf7f-a18bb929****",
  "Phone": "1381111****",
  "TenantId": 0,
  "KeepAliveToken": "006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW",
  "Industry": "edu",
  "Props": {
    "key": "{'dingUserName': u'\\u674e\\u66fc', 'role': 'student'}"
  },
  "WindowDisplayMode": "mode",
  "RiskVerifyInfo": {
    "Email": "user@example.com",
    "LastLockDuration": 1713749778,
    "Locked": "true",
    "Phone": "1381111****"
  },
  "Reason": "null",
  "PasswordStrategy": {
    "TenantPasswordLength": "null",
    "TenantAlternativeChars": [
      "null"
    ]
  },
  "NickName": "user-001",
  "WyId": "0123456789abcdef",
  "OfficeSiteId": "cn-hangzhou+dir-885351****",
  "OfficeSiteName": "test"
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.