# 获取用户 API
获取用户,使用 GET
发起请求,请求地址为 /api/v1/users/{account}
。
GET /api/v1/users/{account}
# 请求 URI
参数名 | 位置 | 类型 | 必填 | 说明 |
---|---|---|---|---|
account | path | 字符串 | 是 | 可以从用户 Id、用户名称、邮箱、手机号码以及 OpenId 中任取一个 |
apiKey | query | 字符串 | 否 | API 密钥,请参考身份认证 |
# 返回
名称 | 类型 | 说明 |
---|---|---|
200 OK | User | 用户 |
401 Unauthorized | Error | 认证错误 |
404 NotFound | Error | 资源不存在错误 |
400 BadRequest | Error | 参数错误 |
# 示例
# 请求示例
GET /api/v1/users/demo
Content-Type: application/json
X-SS-API-KEY: 7cd22002-27a7-4c5d-ba4d-a1c108a20eaf
# 返回示例
{
"id": 1,
"userName": "demo",
"password": "3CPlhZ8UAus=",
"passwordFormat": "Encrypted",
"createDate": "2018-06-17 14:18:45",
"lastResetPasswordDate": "2018-06-17 14:18:45",
"lastActivityDate": "2018-06-17 14:18:45",
"countOfLogin": 0,
"countOfFailedLogin": 0,
"countOfWriting": 0,
"checked": true,
"locked": false,
"displayName": "用户名",
"email": "demo@sample.com",
"mobile": "13888888888",
"avatarUrl": "",
"openId": ""
}
← 删除用户 API 获取用户头像 API →