RefreshWebofficeToken - Intelligent Media Management - Alibaba Cloud Documentation Center

Refreshes the access credential of WebOffice. The access credential of WebOffice is valid for 30 minutes. After the credential expires, you cannot access Weboffice. To access Weboffice again, call this operation to obtain a new credential. The new credential is also valid for 30 minutes.

Operation description

Before you call this operation, make sure that you are familiar with the billing of IMM.****

For more information, see WebOffice billing.
The access token returned by this operation is valid for 30 minutes. After the access token expires, you cannot use it to access the document.
The refresh token returned by this operation is valid for one day. You need to use the refresh token for the next call to the operation before the refresh token expires. After the validity period elapses, the refresh token is invalid.
The returned expiration time is displayed in UTC.

Note An access token is used to actually access a document, whereas a refresh token is used to avoid repeated access configurations.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

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 Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
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.

Operation	Access level	Resource type	Condition key	Associated operation
imm:RefreshWebofficeToken	none	*Project `acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
CredentialConfig	CredentialConfig	No	If you have no special requirements, leave this parameter empty. The configurations of authorization chains. For more information, see Use authorization chains to access resources of other entities.

Response parameters

Parameter	Type	Description	Example

The current API has no return parameters

Examples

Sample success responses

JSONformat

{
  "RequestId": "501339F9-4B70-0CE2-AB8C-866C********",
  "RefreshToken": "72a52ab3702a4123ab5594671a********",
  "AccessToken": "4996466c690a4902846ce00f96********",
  "RefreshTokenExpiredTime": "2021-09-01T12:37:28.950065359Z",
  "AccessTokenExpiredTime": "2021-08-31T13:07:28.950065359Z"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-04-19	The API operation is not deprecated.. The Error code has changed	View Change Details
2023-08-30	The Error code has changed	View Change Details