All Products
Search

This Product

    Elastic Desktop Service:GetLoginToken

    Document Center

    Elastic Desktop Service:GetLoginToken

    Last Updated:Jul 16, 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 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 jaringan kantor, yang memiliki arti sama dengan OfficeSiteId. Kami menyarankan Anda berhenti menggunakan DirectoryId dan menggunakan OfficeSiteId sebagai gantinya. Anda hanya dapat menentukan salah satu dari DirectoryId dan OfficeSiteId, bukan keduanya.

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

    string

    No

    ID jaringan kantor.

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

    string

    No

    ID sesi untuk logon.

    • Jika tidak ada perangkat Autentikasi Multi-Faktor (MFA) virtual yang terikat atau otentikasi sekunder klien tidak diaktifkan, Anda tidak perlu menentukan SessionId.

    • Jika perangkat Autentikasi Multi-Faktor (MFA) virtual terikat atau otentikasi sekunder klien diaktifkan, Anda harus menentukan SessionId untuk tahap otentikasi setelah ADPassword. Anda dapat memperoleh SessionId dari tanggapan verifikasi akun kemudahan (ketika permintaan GetLoginToken berada pada tahap ADPassword).

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

    string

    No

    Tahap otentikasi logon saat ini. Tahap-tahapnya adalah sebagai berikut:

    • ADPassword: memverifikasi informasi pengguna. Tentukan nilai ini saat melakukan otentikasi dengan kredensial akun kemudahan atau akun AD.

    • MFABind: mengikat perangkat Autentikasi Multi-Faktor (MFA) virtual.

    • MFAVerify: memverifikasi kode keamanan yang dihasilkan oleh perangkat Autentikasi Multi-Faktor (MFA) virtual.

    • TokenVerify: melakukan otentikasi sekunder klien.

    • ChangePassword: mengubah kata sandi pengguna.

    • KeepAliveVerify: menukar KeepAliveToken yang valid dengan LoginToken.

    ADPassword
    EndUserId

    string

    No

    Nama pengguna dari pengguna kemudahan atau pengguna AD. Parameter ini diperlukan ketika CurrentStage diatur ke ADPassword.

    alice
    Password

    string

    No

    Kata sandi dari pengguna kemudahan atau pengguna AD. Parameter ini diperlukan ketika CurrentStage diatur ke ADPassword.

    Password1234
    OldPassword

    string

    No

    Kata sandi lama. Parameter ini diperlukan ketika CurrentStage diatur ke ChangePassword.

    OldPassword
    NewPassword

    string

    No

    Kata sandi baru. Parameter ini diperlukan ketika CurrentStage diatur ke ChangePassword.

    NewPassword
    AuthenticationCode

    string

    No

    Kode keamanan yang dihasilkan oleh perangkat MFA virtual. Parameter ini diperlukan ketika CurrentStage diatur ke MFAVerify.

    47****
    ClientOS

    string

    No

    Sistem operasi dari perangkat tempat klien berjalan.

    Windows_NT 10.0.18363 x64
    ClientVersion

    string

    No

    Versi klien. Jika Anda menggunakan klien Elastic Desktop Service, Anda dapat melihat parameter ini di kotak dialog Tentang pada halaman logon klien.

    2.1.0-R-20210731.151756
    TokenCode

    string

    No

    Jika otentikasi sekunder klien diaktifkan di Konsol Elastic Desktop Service dan pengguna logon saat ini diidentifikasi berisiko, kode verifikasi otentikasi sekunder dikirim ke alamat email pengguna akhir. Parameter ini diperlukan ketika CurrentStage diatur ke TokenVerify.

    63****
    KeepAlive

    boolean

    No

    Apakah akan menjaga sesi logon tetap aktif.

    Valid values:

    • null :

      Tidak menjaga sesi logon tetap aktif. [Default]

    • true :

      Menjaga sesi logon tetap aktif.

    • false :

      Tidak menjaga sesi logon tetap aktif.

    false
    KeepAliveToken

    string

    No

    Token yang digunakan untuk menjaga sesi logon tetap aktif. Setelah logon berhasil dengan opsi keep-alive diaktifkan, operasi mengembalikan KeepAliveToken. Selama KeepAliveToken valid, Anda dapat memanggil operasi GetLoginToken dengan CurrentStage diatur ke KeepAliveVerify untuk menukarnya dengan kredensial logon (LoginToken). Parameter ini diperlukan ketika CurrentStage diatur ke KeepAliveVerify.

    hide
    Uuid

    string

    No

    Pengenal unik dari klien. Jika Anda menggunakan klien Elastic Desktop Service, Anda dapat melihat parameter ini di kotak dialog Tentang pada halaman logon klien.

    C78CA9E99315687575DD2844C1F3****
    ClientType

    string

    No

    Tipe klien perangkat lunak Elastic Desktop Service.

    Valid values:

    • HTML5 :

      Klien web.

    • WINDOWS :

      Klien Windows.

    • MACOS :

      Klien macOS.

    • IOS :

      Klien iOS.

    • ANDROID :

      Klien Android.

    WINDOWS
    AvailableFeatures

    object

    No

    string

    No

    ClientName

    string

    No

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter tanggapan.

    Email

    string

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

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

    • Untuk pengguna AD, nilai dikembalikan dalam format nama_pengguna@Nama domain AD.

    alice
    Secret

    string

    Kunci rahasia yang digunakan saat melampirkan perangkat Autentikasi Multi-Faktor (MFA) virtual. Nilai ini digunakan pada tahap MFABind.

    Catatan

    Untuk informasi lebih lanjut tentang setiap tahap otentikasi, lihat deskripsi parameter dari parameter permintaan CurrentStage operasi ini.

    5OCLLKKOJU5HPBX66H3QCTWYI7MH****
    RequestId

    string

    ID permintaan.

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

    string

    Nama pengguna akun kemudahan atau nama pengguna AD.

    alice
    LoginToken

    string

    Kredensial logon.

    v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
    NextStage

    string

    Tahap berikutnya yang diharapkan. Misalnya, jika administrator telah mengaktifkan otentikasi Autentikasi Multi-Faktor (MFA) di Konsol Elastic Desktop Service, setelah otentikasi nama pengguna dan kata sandi lulus (tahap ADPassword), parameter ini mengembalikan MFAVerify, yang menunjukkan bahwa otentikasi Autentikasi Multi-Faktor (MFA) diperlukan.

    Catatan

    Untuk informasi lebih lanjut tentang setiap tahap otentikasi, lihat deskripsi parameter dari parameter permintaan CurrentStage operasi ini.

    MFAVerify
    QrCodePng

    string

    Kode QR dari kunci rahasia yang digunakan saat melampirkan perangkat Autentikasi Multi-Faktor (MFA) virtual. Nilai menggunakan pengkodean Base64. Nilai ini dapat kosong dan digunakan pada tahap MFABind.

    Catatan

    Untuk informasi lebih lanjut tentang setiap tahap otentikasi, lihat deskripsi parameter dari parameter permintaan CurrentStage operasi ini.

    5OCLLKKOJU5HPBX66H3QCTWY******
    Label

    string

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

    test:wuying
    SessionId

    string

    ID sesi. Nilai ini hanya dikembalikan ketika GetLoginToken dipanggil untuk pertama kali dalam sesi yang sama. Untuk tahap berikutnya yang memerlukan beberapa otentikasi, masukkan parameter ini.

    Catatan

    Untuk informasi lebih lanjut tentang setiap tahap otentikasi, lihat deskripsi parameter dari parameter permintaan CurrentStage operasi ini.

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

    string

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

    1381111****
    TenantId

    integer

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

    166353906220****
    KeepAliveToken

    string

    Token yang digunakan untuk menjaga sesi logon tetap aktif. Setelah logon berhasil dengan opsi keep-alive diaktifkan, operasi mengembalikan KeepAliveToken. Jika opsi keep-alive tidak diaktifkan, nilai kosong akan dikembalikan.

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

    string
    Catatan

    Ini adalah bidang internal dan tidak tersedia untuk penggunaan publik.

    edu
    Props

    object
    Catatan

    Ini adalah bidang internal dan tidak tersedia untuk penggunaan publik.

    string
    Catatan

    Ini adalah bidang internal dan tidak tersedia untuk penggunaan publik.

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

    string
    Catatan

    Ini adalah bidang internal dan tidak tersedia untuk penggunaan publik.

    mode
    RiskVerifyInfo

    object

    Informasi identifikasi risiko logon.

    Email

    string

    Alamat email yang digunakan untuk verifikasi identitas ketika verifikasi risiko dipicu.

    user@example.com
    LastLockDuration

    integer

    Durasi penguncian akun.

    1713749778
    Locked

    string

    Apakah akun terkunci.

    Valid values:

    • true :

      Terkunci.

    • false :

      Tidak terkunci.

    true
    Phone

    string

    Nomor telepon yang digunakan untuk verifikasi identitas ketika verifikasi risiko dipicu.

    1381111****
    Reason

    string
    Catatan

    Ini adalah bidang internal dan tidak tersedia untuk penggunaan publik.

    null
    PasswordStrategy

    object
    Catatan

    Ini adalah bidang internal dan tidak tersedia untuk penggunaan publik.

    TenantPasswordLength

    string
    Catatan

    Ini adalah bidang internal dan tidak tersedia untuk penggunaan publik.

    null
    TenantAlternativeChars

    array
    Catatan

    Ini adalah bidang internal dan tidak tersedia untuk penggunaan publik.

    string
    Catatan

    Ini adalah bidang internal dan tidak tersedia untuk penggunaan publik.

    null
    NickName

    string

    WyId

    string

    OfficeSiteId

    string

    OfficeSiteName

    string

    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": "",
  "WyId": "",
  "OfficeSiteId": "",
  "OfficeSiteName": ""
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.