Todos os produtos
Search

Este produto

    Elastic Desktop Service:GetLoginToken

    Central de documentação

    Elastic Desktop Service:GetLoginToken

    Última atualização: Jul 16, 2026

    Obtém as credenciais de logon.

    Experimente agora

    Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

    Testar

    Autorização RAM

    Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    RegionId

    string

    Sim

    O ID da região. Você pode chamar DescribeRegions para consultar as regiões suportadas pelo Elastic Desktop Service.

    cn-hangzhou
    ClientId

    string

    Sim

    O ID exclusivo gerado pelo cliente.

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

    string

    Não

    O ID da rede corporativa, que tem o mesmo significado que OfficeSiteId. Recomendamos que você pare de usar DirectoryId e use OfficeSiteId em seu lugar. Você pode especificar apenas um entre DirectoryId e OfficeSiteId, não ambos.

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

    string

    Não

    O ID da rede corporativa.

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

    string

    Não

    O ID da sessão para logon.

    • Se nenhum dispositivo MFA virtual estiver vinculado ou a autenticação secundária do cliente não estiver ativada, você não precisa especificar SessionId.

    • Se um dispositivo MFA virtual estiver vinculado ou a autenticação secundária do cliente estiver ativada, você deve especificar SessionId para os estágios de autenticação após ADPassword. Você pode obter SessionId na resposta da verificação de conta de conveniência (quando a solicitação GetLoginToken estiver no estágio ADPassword).

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

    string

    Não

    O estágio atual de autenticação de logon. Os estágios são os seguintes:

    • ADPassword: verifica as informações do usuário. Especifique este valor ao autenticar com as credenciais de uma conta de conveniência ou de uma conta AD.

    • MFABind: vincula um dispositivo MFA virtual.

    • MFAVerify: verifica o código de segurança gerado pelo dispositivo MFA virtual.

    • TokenVerify: realiza a autenticação secundária do cliente.

    • ChangePassword: altera a senha do usuário.

    • KeepAliveVerify: troca um KeepAliveToken válido por um LoginToken.

    ADPassword
    EndUserId

    string

    Não

    O nome de usuário do usuário de conveniência ou do usuário AD. Este parâmetro é obrigatório quando CurrentStage está definido como ADPassword.

    alice
    Password

    string

    Não

    A senha do usuário de conveniência ou do usuário AD. Este parâmetro é obrigatório quando CurrentStage está definido como ADPassword.

    Password1234
    OldPassword

    string

    Não

    A senha antiga. Este parâmetro é obrigatório quando CurrentStage está definido como ChangePassword.

    OldPassword
    NewPassword

    string

    Não

    A nova senha. Este parâmetro é obrigatório quando CurrentStage está definido como ChangePassword.

    NewPassword
    AuthenticationCode

    string

    Não

    O código de segurança gerado pelo dispositivo MFA virtual. Este parâmetro é obrigatório quando CurrentStage está definido como MFAVerify.

    47****
    ClientOS

    string

    Não

    O sistema operacional do dispositivo no qual o cliente é executado.

    Windows_NT 10.0.18363 x64
    ClientVersion

    string

    Não

    A versão do cliente. Se você usar o cliente do Elastic Desktop Service, poderá visualizar este parâmetro na caixa de diálogo Sobre na página de logon do cliente.

    2.1.0-R-20210731.151756
    TokenCode

    string

    Não

    Se a autenticação secundária do cliente estiver ativada no console do Elastic Desktop Service e o usuário de logon atual for identificado como de risco, um código de verificação de autenticação secundária será enviado para o endereço de e-mail do usuário final. Este parâmetro é obrigatório quando CurrentStage está definido como TokenVerify.

    63****
    KeepAlive

    boolean

    Não

    Especifica se a sessão de logon deve ser mantida ativa.

    Valores válidos:

    • null :

      Não manter a sessão de logon ativa. [Padrão]

    • true :

      Manter a sessão de logon ativa.

    • false :

      Não manter a sessão de logon ativa.

    false
    KeepAliveToken

    string

    Não

    O token usado para manter a sessão de logon ativa. Após um logon bem-sucedido com a opção keep-alive ativada, a operação retorna um KeepAliveToken. Enquanto o KeepAliveToken for válido, você pode chamar a operação GetLoginToken com CurrentStage definido como KeepAliveVerify para trocá-lo por uma credencial de logon (LoginToken). Este parâmetro é obrigatório quando CurrentStage está definido como KeepAliveVerify.

    hide
    Uuid

    string

    Não

    O identificador exclusivo do cliente. Se você usar o cliente do Elastic Desktop Service, poderá visualizar este parâmetro na caixa de diálogo Sobre na página de logon do cliente.

    C78CA9E99315687575DD2844C1F3****
    ClientType

    string

    Não

    O tipo de cliente de software do Elastic Desktop Service.

    Valores válidos:

    • HTML5 :

      Cliente Web.

    • WINDOWS :

      Cliente Windows.

    • MACOS :

      Cliente macOS.

    • IOS :

      Cliente iOS.

    • ANDROID :

      Cliente Android.

    WINDOWS
    AvailableFeatures

    object

    Não

    string

    Não

    ClientName

    string

    Não

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Os parâmetros de resposta.

    Email

    string

    O endereço de e-mail do usuário. Este valor é retornado com o LoginToken após o logon.

    • Para um usuário de conveniência, o endereço de e-mail especificado quando o usuário de conveniência foi criado é retornado.

    • Para um usuário AD, o valor é retornado no formato nome_de_usuário@nome_do_domínio_AD.

    alice
    Secret

    string

    A chave secreta usada ao vincular um dispositivo MFA virtual. Este valor é usado no estágio MFABind.

    Nota

    Para mais informações sobre cada estágio de autenticação, consulte a descrição do parâmetro de solicitação CurrentStage desta operação.

    5OCLLKKOJU5HPBX66H3QCTWYI7MH****
    RequestId

    string

    O ID da solicitação.

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

    string

    O nome de usuário da conta de conveniência ou do usuário AD.

    alice
    LoginToken

    string

    A credencial de logon.

    v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
    NextStage

    string

    O próximo estágio esperado. Por exemplo, se o administrador tiver ativado a autenticação MFA no console do Elastic Desktop Service, após a aprovação da autenticação de nome de usuário e senha (estágio ADPassword), este parâmetro retorna MFAVerify, indicando que a autenticação MFA é necessária.

    Nota

    Para mais informações sobre cada estágio de autenticação, consulte a descrição do parâmetro de solicitação CurrentStage desta operação.

    MFAVerify
    QrCodePng

    string

    O código QR da chave secreta usada ao vincular um dispositivo MFA virtual. O valor usa codificação Base64. Este valor pode estar vazio e é usado no estágio MFABind.

    Nota

    Para mais informações sobre cada estágio de autenticação, consulte a descrição do parâmetro de solicitação CurrentStage desta operação.

    5OCLLKKOJU5HPBX66H3QCTWY******
    Label

    string

    A propriedade do usuário de conveniência. Se o usuário for um usuário AD, um valor vazio será retornado.

    test:wuying
    SessionId

    string

    O ID da sessão. Este valor é retornado apenas quando GetLoginToken é invocado pela primeira vez dentro da mesma sessão. Para estágios subsequentes que exigem múltiplas autenticações, passe este parâmetro.

    Nota

    Para mais informações sobre cada estágio de autenticação, consulte a descrição do parâmetro de solicitação CurrentStage desta operação.

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

    string

    O número de telefone do usuário de conveniência. Se o usuário for um usuário AD, um valor vazio será retornado.

    1381111****
    TenantId

    integer

    O ID da conta Alibaba Cloud. Este valor é usado para identificação de terminal de hardware.

    166353906220****
    KeepAliveToken

    string

    O token usado para manter a sessão de logon ativa. Após um logon bem-sucedido com a opção keep-alive ativada, a operação retorna um KeepAliveToken. Se a opção keep-alive não estiver ativada, um valor vazio será retornado.

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

    string
    Nota

    Este é um campo interno e não está disponível para uso público.

    edu
    Props

    object
    Nota

    Este é um campo interno e não está disponível para uso público.

    string
    Nota

    Este é um campo interno e não está disponível para uso público.

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

    string
    Nota

    Este é um campo interno e não está disponível para uso público.

    mode
    RiskVerifyInfo

    object

    As informações de identificação de risco de logon.

    Email

    string

    O endereço de e-mail usado para verificação de identidade quando a verificação de risco é acionada.

    user@example.com
    LastLockDuration

    integer

    A duração do bloqueio da conta.

    1713749778
    Locked

    string

    Indica se a conta está bloqueada.

    Valores válidos:

    • true :

      Bloqueada.

    • false :

      Não bloqueada.

    true
    Phone

    string

    O número de telefone usado para verificação de identidade quando a verificação de risco é acionada.

    1381111****
    Reason

    string
    Nota

    Este é um campo interno e não está disponível para uso público.

    null
    PasswordStrategy

    object
    Nota

    Este é um campo interno e não está disponível para uso público.

    TenantPasswordLength

    string
    Nota

    Este é um campo interno e não está disponível para uso público.

    null
    TenantAlternativeChars

    array
    Nota

    Este é um campo interno e não está disponível para uso público.

    string
    Nota

    Este é um campo interno e não está disponível para uso público.

    null
    NickName

    string

    WyId

    string

    OfficeSiteId

    string

    OfficeSiteName

    string

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "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": ""
}

    Códigos de erro

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.