文档首页/ iMasterCloud/ API参考/ API说明/ 统一认证服务/ 手机app接口/ 手机端用户名密码登录
更新时间：2025-09-24 GMT+08:00
查看PDF
分享

手机端用户名密码登录

典型场景

手机端用户名密码登录。

接口功能

手机端用户名密码登录。

接口约束

该接口不需要认证。

调用方法

POST

URI

/controller/campus/api/v1/app/user-login

请求参数

表1 header参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

x-org-id

否

string

0~128个字符。

-

租户id

-

x-real-client-addr

否

string

0~128个字符。

-

该字段可能包含敏感信息和个人数据，请妥善做好保护。

真实客户端地址

-

x-multi-region-name

否

string

0~128个字符。

-

区域名称

-

UNISSO_V_C_S

否

string

0~5000个字符。

-

UniSSO的认证凭证

-
表2 body参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

appAuthCredit

是

REFERENCE

详细请参见表3。

认证凭据。

-
表3 AppAuthAppCredit对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

grantType

是

string

0~32个字符。

-

类型。支持的类型为password、verifyCode、refreshToken和accessToken。

"verifyCode"

userName

是

string

1~32个字符。

-

用户名。

"userName"

value

是

string

8~32个字符。

-

该字段可能包含敏感信息和个人数据，请妥善做好保护。

密码。当grantType为password时，该参数是必选参数。

"********"

appClientId

是

string

0~128个字符。

-

该字段可能包含敏感信息和个人数据，请妥善做好保护。

终端唯一标识。

"******"

verifyCode

否

string

4~6个字符。

-

该字段可能包含敏感信息和个人数据，请妥善做好保护。

图片验证码。当30分钟内登录失败次数大于等于3次时，该参数是必填参数。

"f5dj"

请求示例

HTTP的示例 
POST /controller/campus/api/v1/app/user-login HTTP/1.1
Accept:application/json
Content-Type:application/json;charset=UTF-8
{
   "grantType": "verifyCode",
   "userName": "string",
   "value": "string",
   "appClientId": "Hash of IMEI"
}

响应参数

返回状态码为200：成功。

表4 UserLoginOutput对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

errorCode

string

0~256个字符。

-

错误码。

"success"

accessToken

string

0~256个字符。

-

该字段可能包含敏感信息和个人数据，请妥善做好保护。

会话ID。

"x-******"

roaRand

string

0~128个字符。

-

crsftoken防跨站攻击。

"******"

expires

string

0~32个字符。

-

过期时间，单位：秒。

"1800"

refreshToken

string

0~512个字符。

-

该字段可能包含敏感信息和个人数据，请妥善做好保护。

会话延期token。

"r-******"

additionalInfo

object

0~128个字符。

-

附加信息。

{"passwdStatus":"init"}

regionName

string

0~128个字符。

-

区域名称

"Region1"

regionIp

string

0~128个字符。

-

区域ip

"192.168.1.1"

返回状态码为400：参数错误。

详细信息请参见实际响应消息体。

返回状态码为500：内部服务器错误。

详细信息请参见实际响应消息体。

响应示例

返回状态码为200：成功。

HTTP/1.1 200 OK
Date: Sat, 30 Jan 2021 11:40:48 GMT+33m 49s
Server: product only
Content-Type: application/json
{
   "errorCode": "success",
   "accessToken": "x-******",
   "roaRand": "******",
   "expires": 1800,
   "refreshToken": "r-******",
   "additionalInfo": {"passwdStatus":"init"},
   "regionIp": "192.168.0.1",
   "regionName": "region1"
}

返回状态码为400：参数错误。

HTTP/1.1 400 Bad Request
Date: Wed,24 Sep 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive

返回状态码为500：内部服务器错误。

HTTP/1.1 500 Internal Server Error
Date: Wed,24 Sep 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
父主题： 手机app接口

相关文档