Obtiene las credenciales de inicio de sesión.
Pruébelo ahora
Test
Autorización de RAM
Parámetros de la solicitud
|
Parámetro |
Tipo |
Obligatorio |
Descripción |
Ejemplo |
| RegionId |
string |
Sí |
El ID de la región. Puede llamar a la operación DescribeRegions para consultar las regiones admitidas por Elastic Desktop Service. |
cn-hangzhou |
| ClientId |
string |
Sí |
El ID único generado por el cliente. |
f4a0dc8e-1702-4728-9a60-95b27a35**** |
| DirectoryId |
string |
No |
El ID del espacio de trabajo. Este parámetro tiene el mismo significado que OfficeSiteId. Se recomienda utilizar OfficeSiteId en lugar de DirectoryId. Solo puede especificar DirectoryId o OfficeSiteId, pero no ambos. |
cn-hangzhou+dir-885351**** |
| OfficeSiteId |
string |
No |
El ID del espacio de trabajo. |
cn-hangzhou+dir-885351**** |
| SessionId |
string |
No |
El ID de sesión para el inicio de sesión.
|
cd45e873-650d-4d70-acb9-f996187a**** |
| CurrentStage |
string |
No |
La etapa actual de autenticación de inicio de sesión. Valores válidos:
|
ADPassword |
| EndUserId |
string |
No |
El nombre de usuario del usuario de conveniencia o usuario de AD. Este parámetro es obligatorio cuando CurrentStage se establece en ADPassword. |
alice |
| Password |
string |
No |
La contraseña del usuario de conveniencia o usuario de AD. Este parámetro es obligatorio cuando CurrentStage se establece en ADPassword. |
Password1234 |
| OldPassword |
string |
No |
La contraseña anterior. Este parámetro es obligatorio cuando CurrentStage se establece en ChangePassword. |
OldPassword |
| NewPassword |
string |
No |
La nueva contraseña. Este parámetro es obligatorio cuando CurrentStage se establece en ChangePassword. |
NewPassword |
| AuthenticationCode |
string |
No |
El código de seguridad generado por el dispositivo MFA virtual. Este parámetro es obligatorio cuando CurrentStage se establece en MFAVerify. |
47**** |
| ClientOS |
string |
No |
El sistema operativo del dispositivo en el que se ejecuta el cliente. |
Windows_NT 10.0.18363 x64 |
| ClientVersion |
string |
No |
La versión del cliente. Si utiliza el cliente Wuying, puede consultar este parámetro en el cuadro de diálogo Acerca de en la página de inicio de sesión del cliente. |
2.1.0-R-20210731.151756 |
| TokenCode |
string |
No |
El código de verificación para la autenticación secundaria. Si la autenticación secundaria del lado del cliente está habilitada en la consola de Elastic Desktop Service y el usuario que inicia sesión actualmente se identifica como de riesgo, el código de verificación se envía a la dirección de correo electrónico del usuario final. Este parámetro es obligatorio cuando CurrentStage se establece en TokenVerify. |
63**** |
| KeepAlive |
boolean |
No |
Especifica si se debe mantener la sesión del usuario iniciada. Valores válidos:
|
false |
| KeepAliveToken |
string |
No |
El token que se utiliza para mantener la sesión del usuario iniciada. Después de un inicio de sesión exitoso y si el usuario habilita la opción de mantener la sesión iniciada, la API devuelve KeepAliveToken. Dentro del período de validez de KeepAliveToken, puede llamar a la operación GetLoginToken y establecer CurrentStage en KeepAliveVerify para intercambiarlo por un token de inicio de sesión (LoginToken). Este parámetro es obligatorio cuando CurrentStage se establece en KeepAliveVerify. |
hide |
| Uuid |
string |
No |
El identificador único del cliente. Si utiliza el cliente Wuying, puede consultar este parámetro en el cuadro de diálogo Acerca de en la página de inicio de sesión del cliente. |
C78CA9E99315687575DD2844C1F3**** |
| ClientType |
string |
No |
El tipo de cliente de software de Wuying. Valores válidos:
|
WINDOWS |
| AvailableFeatures |
object |
No |
Las funciones admitidas por el cliente. |
|
|
string |
No |
Las funciones admitidas por el cliente. |
1 |
|
| ClientName |
string |
No |
El nombre del cliente. |
demo-client |
Elementos de la respuesta
|
Elemento |
Tipo |
Descripción |
Ejemplo |
|
object |
La información de la respuesta. |
||
|
string |
La dirección de correo electrónico del usuario. Este parámetro se devuelve junto con LoginToken después del inicio de sesión.
|
alice |
|
| Secret |
string |
La clave secreta que se utiliza para vincular un dispositivo MFA virtual. Se utiliza en la etapa Nota
Para obtener más información sobre cada etapa de autenticación, consulte la descripción del parámetro de solicitud |
5OCLLKKOJU5HPBX66H3QCTWYI7MH**** |
| RequestId |
string |
El ID de la solicitud. |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
| EndUserId |
string |
El nombre de usuario de la cuenta de conveniencia o del usuario de AD. |
alice |
| LoginToken |
string |
El token de inicio de sesión. |
v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b**** |
| NextStage |
string |
La siguiente etapa esperada. Por ejemplo, si el administrador habilita la autenticación MFA en la consola de Elastic Desktop Service, este parámetro devuelve Nota
Para obtener más información sobre cada etapa de autenticación, consulte la descripción del parámetro de solicitud |
MFAVerify |
| QrCodePng |
string |
El código QR de la clave secreta que se utiliza para vincular un dispositivo MFA virtual. Utiliza codificación Base64. Este parámetro puede estar vacío y se utiliza en la etapa Nota
Para obtener más información sobre cada etapa de autenticación, consulte la descripción del parámetro de solicitud |
5OCLLKKOJU5HPBX66H3QCTWY****** |
| Label |
string |
Las propiedades del usuario de conveniencia. Si el usuario es un usuario de AD, se devuelve un valor vacío. |
test:wuying |
| SessionId |
string |
El ID de sesión. Este parámetro se devuelve solo cuando se invoca Nota
Para obtener más información sobre cada etapa de autenticación, consulte la descripción del parámetro de solicitud |
d6ec166d-ab93-4286-bf7f-a18bb929**** |
| Phone |
string |
El número de teléfono celular del usuario de conveniencia. Si el usuario es un usuario de AD, se devuelve un valor vacío. |
1381111**** |
| TenantId |
integer |
El ID de la cuenta de Alibaba Cloud. Este parámetro se utiliza para la identificación de terminales de hardware. |
166353906220**** |
| KeepAliveToken |
string |
El token que se utiliza para mantener la sesión del usuario iniciada. Después de un inicio de sesión exitoso y si el usuario habilita la opción de mantener la sesión iniciada, la API devuelve KeepAliveToken. Si la opción de mantener la sesión iniciada no está habilitada, se devuelve un valor vacío. |
006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW |
| Industry |
string |
Nota
Campo privado interno. No disponible para uso externo. |
edu |
| Props |
object |
Nota
Campo privado interno. No disponible para uso externo. |
|
|
string |
Nota
Campo privado interno. No disponible para uso externo. |
{'dingUserName': u'\u674e\u66fc', 'role': 'student'} |
|
| WindowDisplayMode |
string |
Nota
Campo privado interno. No disponible para uso externo. |
mode |
| RiskVerifyInfo |
object |
La información de identificación de riesgos de inicio de sesión. |
|
|
string |
La dirección de correo electrónico utilizada para la verificación cuando se activa la verificación de identidad. |
user@example.com |
|
| LastLockDuration |
integer |
La duración del bloqueo de la cuenta. |
1713749778 |
| Locked |
string |
Indica si la cuenta está bloqueada. Valores válidos:
|
true |
| Phone |
string |
El número de teléfono celular utilizado para la verificación cuando se activa la verificación de identidad. |
1381111**** |
| Reason |
string |
Nota
Campo privado interno. No disponible para uso externo. |
null |
| PasswordStrategy |
object |
Nota
Campo privado interno. No disponible para uso externo. |
|
| TenantPasswordLength |
string |
Nota
Campo privado interno. No disponible para uso externo. |
null |
| TenantAlternativeChars |
array |
Nota
Campo privado interno. No disponible para uso externo. |
|
|
string |
Nota
Campo privado interno. No disponible para uso externo. |
null |
|
| NickName |
string |
El alias del usuario. |
user-001 |
| WyId |
string |
0123456789abcdef |
|
| OfficeSiteId |
string |
El ID del espacio de trabajo. |
cn-hangzhou+dir-885351**** |
| OfficeSiteName |
string |
El nombre del espacio de trabajo. |
test |
Ejemplos
Respuesta exitosa
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": "user-001",
"WyId": "0123456789abcdef",
"OfficeSiteId": "cn-hangzhou+dir-885351****",
"OfficeSiteName": "test"
}
Códigos de error
Consulte Códigos de error para ver la lista completa.
Notas de la versión
Consulte Notas de la versión para ver la lista completa.