Help Center > > API Reference> Northbound Python SDK API Reference> Service API List> Secure Application Access> Refreshing a Token

Refreshing a Token

Updated at: Aug 28, 2019 GMT+08:00

Typical Scenario

The access token obtained by calling the Authentication API has a valid time. When the access token is about to expire, an NA can call this API to obtain a new access token.

API Function

This API is used by an NA to obtain a new access token from the IoT platform when the access token is about to expire.

API Description

1
def refreshAuthToken(self, arInDTO)

Class

Authentication

Parameter Description

Parameter

Mandatory or Optional

Type

Location

Description

arInDTO

Mandatory

AuthRefreshInDTO

body

For details, see AuthRefreshInDTO.

AuthRefreshInDTO structure

Parameter

Mandatory or Optional

Type

Location

Description

appId

Mandatory

String(256)

body

Uniquely identifies an NA. This parameter is used to identify an NA that can call open APIs provided by the IoT platform. The value of this parameter is obtained when the NA is created on the SP portal of the IoT platform.

secret

Mandatory

String(256)

body

Indicates the password that corresponds to appId. It is used to log in to the IoT platform. The value of this parameter is obtained when the NA is created on the SP portal of the IoT platform.

refreshToken

Mandatory

String(256)

body

Indicates the refresh token used for obtaining a new accessToken. The value of this parameter is obtained when the Authentication API is called.

Return Value

AuthRefreshOutDTO structure

Parameter

Type

Description

scope

String(256)

Indicates the applied permission range. This parameter has a fixed value of default.

tokenType

String(256)

Indicates the access token type. This parameter has a fixed value of bearer.

expiresIn

Number(256)

Indicates the validity time for the IoT platform to generate and return the accessToken, in seconds.

accessToken

String(256)

Indicates the authentication parameter that is used to access APIs of the IoT platform.

refreshToken

String(256)

Indicates the authentication parameter that is used to update the accessToken. The validity period of this parameter is 1 month.

Error Codes

HTTP Status Code

Error Code

Error Description

Remarks

400

100449

The device is freezed cant operate.

The user does not have the operation permission.

Recommended handling: Check whether the user corresponding to appId has the permission to call the API.

400

102202

Required Parameter is null or empty.

Mandatory fields cannot be left blank.

Recommended handling: Check whether the mandatory parameters in the request are set.

400

50400

The input is invalid.

An input parameter is invalid.

Recommended handling: Check whether parameters carried in the API call request are valid.

401

100208

AppId or secret is not right.

appId or secret is incorrect.

Recommended handling:

  • Check whether appId and secret are correct. Specifically, check for new or missing characters.
  • Check whether the IP address in the request path is correct.

500

50252

Internal server error.

An internal server error occurs.

Recommended handling: An internal error occurs on the IoT platform. Contact IoT platform maintenance personnel.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel