IoTIoT

Compute
Elastic Cloud Server
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
Domain Name Service
VPC Endpoint
Cloud Connect
Enterprise Switch
Security & Compliance
Anti-DDoS
Web Application Firewall
Host Security Service
Data Encryption Workshop
Database Security Service
Advanced Anti-DDoS
Data Security Center
Container Guard Service
Situation Awareness
Managed Threat Detection
Compass
Cloud Certificate Manager
Anti-DDoS Service
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GaussDB NoSQL
GaussDB(for MySQL)
Distributed Database Middleware
GaussDB(for openGauss)
Developer Services
ServiceStage
Distributed Cache Service
Simple Message Notification
Application Performance Management
Application Operations Management
Blockchain Service
API Gateway
Cloud Performance Test Service
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
DevCloud
ProjectMan
CodeHub
CloudRelease
CloudPipeline
CloudBuild
CloudDeploy
Cloud Communications
Message & SMS
Cloud Ecosystem
Marketplace
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP License Service
Support Plans
Customer Operation Capabilities
Partner Support Plans
Professional Services
enterprise-collaboration
Meeting
IoT
IoT
Intelligent EdgeFabric
DeveloperTools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Updated at: Feb 24, 2022 GMT+08:00

Refreshing a Token

Typical Scenario

An 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 Prototype

Method

POST

URL

https://server:port/iocm/app/sec/v1.1.0/refreshToken

Transport Protocol

HTTPS

Request Parameters

Parameter

Mandatory or Optional

Type

Location

Description

appId

Mandatory

String(256)

body

Identifies an application that can be accessed on the IoT platform. The value of this parameter is allocated by the IoT platform when the application is created on the platform.

secret

Mandatory

String(256)

body

Indicates a secret used to access the IoT platform. It maps to appId. The value of this parameter is allocated by the IoT platform when the application is created on the platform.

refreshToken

Mandatory

String(256)

body

Indicates the refresh token used for obtaining a new accessToken. The refreshToken is obtained when you call the Authentication or Refreshing a Token API.

Response Parameters

Status Code: 200 OK

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

Integer(256)

Indicates the validity period of the accessToken. This parameter has a fixed value of 3600 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 for the Refreshing a Token API. A refreshToken is valid for one month. When the accessToken is about to expire, you can call the Refreshing a Token API to obtain a new one.

Request Example

Method: POST
Request:
https://server:port/iocm/app/sec/v1.1.0/refreshToken
Content-Type: application/json
Body:
{
  "appId": "******",
  "secret": "******",
  "refreshToken": "******"
}

Response Example

Response:
Status Code: 200 OK
Content-Type: application/json
Body:
{
  "accessToken": "*******",
  "tokenType": "*******",
  "expiresIn": "*******",
  "refreshToken": "*******",
  "scope": "*******"
}

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?

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