Obtains logon credentials.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The ID of the region. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
ClientId | string | Yes | The ID of the Alibaba Cloud Workspace client. The system generates a unique ID for each client. | f4a0dc8e-1702-4728-9a60-95b27a35**** |
DirectoryId | string | No | The ID of the workspace. The parameter is the same as the | cn-hangzhou+dir-885351**** |
OfficeSiteId | string | Yes | The ID of the workspace. | cn-hangzhou+dir-885351**** |
SessionId | string | No | The ID of the session.
| cd45e873-650d-4d70-acb9-f996187a**** |
CurrentStage | string | No | The logon authentication stage. Valid values:
| ADPassword |
EndUserId | string | No | The name of the convenience user or the AD user. This parameter is required if you set | alice |
Password | string | No | The password of the convenience user or the AD user. This parameter is required if you set | Password1234 |
OldPassword | string | No | The current password. This parameter is required if you set | OldPassword |
NewPassword | string | No | The new password. This parameter is required if you set | NewPassword |
AuthenticationCode | string | No | The verification code that is generated by the virtual MFA device. This parameter is required if you set | 47**** |
ClientOS | string | No | The OS that the client runs. | Windows_NT 10.0.1**** x64 |
ClientVersion | string | No | The version of the client. When you use an Alibaba Cloud Workspace client, you can view the client version in the About dialog box on the client logon page. | 2.1.0-R-20210731.1**** |
TokenCode | string | No | If two-factor authentication is enabled in the Elastic Desktop Service (EDS) console and the system detects that the identity of the logon user may have security risks, the system sends a verification code for two-factor authentication to the email address of the user. This parameter is required if you set | 63**** |
KeepAlive | boolean | No | Specifies whether to keep the user logged on to the client. Valid values:
| false |
KeepAliveToken | string | No | The token that is used to keep the user logged on to the client. After the user logs on to the client and KeepAlive is set to true, the | hide |
Uuid | string | No | The unique identifier of the client. When you use an Alibaba Cloud Workspace client, you can view the client version in the About dialog box on the client logon page. | C78CA9E99315687575DD2844C1F3**** |
ClientType | string | No | The type of the software client. Enumeration Value:
| Windows |
Response parameters
Examples
Sample success responses
JSON
format
{
"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"
}
Error codes
For a list of error codes, visit the Service error codes.