Refreshes a logon token.
Description
The validity period of a logon token is 15 minutes. If an end user does not exit a client in 15 minutes, the logon token for the client must be refreshed. You can call this operation to refresh the client token.
Authorization information
The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All resourcesis used in the Resource type column of the operation.
- Condition keyword: refers to the condition keyword defined by the cloud product itself.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operate | Access level | Resource type | Condition keyword | Association operation |
|---|---|---|---|---|
| ecd:RefreshLoginToken | WRITE |
|
| none |
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 ID is unique. | f4a0dc8e-1702-4728-9a60-95b27a35**** |
| DirectoryId | string | No | NoteThis parameter is not available to the public. | cn-hangzhou+dir-jedbpr4sl9l37**** |
| OfficeSiteId | string | Yes | The ID of the workspace. | cn-shanghai+dir-238191**** |
| SessionId | string | No | The ID of the session. | cd45e873-650d-4d70-acb9-f996187a**** |
| EndUserId | string | Yes | The name of the end user. | alice |
| LoginToken | string | Yes | The logon token. | v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b**** |
Response parameters
Example
Normal return example
JSONFormat
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"LoginToken": "v1c27bab6c205b2fdfac916434306375722776d6aa89e30b7836d18c95ade9137f0f5ac4325260782184e96ee2b3f0****"
}Error codes
For a list of error codes, visit the API error center.