文档首页> > API参考> IoT平台北向API参考> 接口列表> 应用安全接入> 鉴权

鉴权

更新时间: 2019-01-14 17:16

典型场景

第三方应用首次访问物联网平台的开放API时,需调用此接口完成接入认证;第三方应用在物联网平台的认证过期后,需调用此接口重新进行认证,才能继续访问物联网平台的开放API。

接口功能

支持第三方应用在首次访问物联网平台的开放API之前,完成在物联网平台的接入认证。

变更记录

接口版本

物联网平台版本

变更说明

1.1.0

V100R001C52

新增错误码100008

1.1.0

V100R001C30

响应参数增加refreshToken

1.1.0

V100R001C10

新增接口

注意事项

鉴权接口是调用其他API的前提,除了调用鉴权接口(Auth),其他接口调用都需要在request header中携带参数app_key和Authorization:Bearer。app_key为参数中的appId,Authorization的值即为调用Auth接口获取到的accessToken。

如果多次获取accessToken,则之前的accessToken失效,后一次获取的accessToken才有效。请勿并发获取accessToken。

接口原型

请求方法

POST

请求地址

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

传输协议

HTTPS

请求参数

参数

必选/可选

类型

位置

描述

appId

必选

String(256)

body

第三方应用的身份标识,用于唯一标识一个应用。开发者可通过该标识来指定哪个应用来调用物联网平台的开放API。appid在物联网平台的SP Portal上创建应用时获得。

secret

必选

String(256)

body

第三方应用的密码,与appId对应,用于登录访问物联网平台。secret在物联网平台的SP Portal上创建应用时获得。

响应参数

Status Code: 200 OK

参数

类型

描述

scope

String(256)

申请权限范围,即accessToken所能访问物联网平台资源的范围,参数值固定为default。

tokenType

String(256)

accessToken的类型,参数值固定为bearer。

expiresIn

Integer(256)

平台生成并返回accessToken的有效时间,单位为秒。

accessToken

String(256)

鉴权参数,访问物联网平台API接口的凭证。

refreshToken

String(256)

鉴权参数,用来刷新accessToken,refreshToken的有效时间为1个月。

请求示例

Method: POST

request:

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

Content-Type:application/x-www-form-urlencoded

appId=******&secret=******

响应示例

response:

Status Code: 200 OK

Content-Type: application/json

Body:

{

"scope": "default",

"tokenType": "bearer",

"expiresIn": "*******",

"accessToken": "*******",

"refreshToken": "*******"

}

错误码

Http状态码

错误码

错误描述

说明

200

100203

The application is not existed.

应用不存在。

处理建议:请检查请求参数中的appId是否有误。

400

100449

The device is freezed cant operate.

用户无操作权限。

处理建议:请检查appId所对应用户是否有接口调用权限。

400

102202

Required Parameter is null or empty.

必选参数为空。

处理建议:请检查请求参数中的必选参数是否已填写。

401

100208

AppId or secret is not right.

appId或secret错误。

处理建议:

  1. 请检查appId和secret是否有误,是否新增字符或缺少字符。
  2. 请检查请求路径中的IP地址是否有误。

500

50252

Internal server error.

服务器运行内部错误。

处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

在文档使用中是否遇到以下问题







请至少选择或填写一项反馈信息

字符长度不能超过100

反馈内容不能为空!

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区