中望帐号
  1. 用户
中望帐号
  • 服务更新记录
  • 接入说明
  • 网关和规范
  • 客户端接入\变更申请
  • 全局返回码
  • 用户一致性
  • 用户消息推送
  • 授权认证
    • 获取服务配置
      GET
    • 获取用户授权code
      GET
    • 使用授权code兑换用户令牌
      POST
    • 刷新令牌
      POST
    • 受信客户端获取令牌
      POST
    • 密码模式获取用户令牌
      POST
  • 用户
    • 获取用户基本信息(OIDC)-不建议使用
      GET
    • 获取用户基本信息
      GET
    • 修改用户基本信息
      POST
    • 修改用户头像
      POST
    • 获取用户详细信息
      GET
    • 修改用户详细信息
      POST
    • 获取用户第三方绑定信息
      GET
    • 获取用户资讯接收设置
      GET
    • 结束会话(退出登录)
      GET
    • 获取客户端配置
      GET
    • 获取用户信息修改次数
      GET
    • 修改帐号安全信息
      GET
    • 获取用户当前IP信息
      GET
    • 发送验证码
      POST
  • 受信客户端接口
    • 用户
      • 获取用户GUID列表
      • 批量查询用户GUID
      • 批量获取用户详细信息
      • 批量获取用户第三方绑定信息
      • 通过第三方登录信息查询用户
      • 创建用户
      • 查询最近的登录记录
      • 增加用户第三方绑定信息
      • 批量修改用户详细信息
    • 企业
      • 刷新企业用户部门
    • 其他
      • 推送服务消息
  • OEM受信客户端
    • OEM授权认证对接说明
    • 获取OEM用户列表
    • 注册OEM用户
    • 更新OEM用户
    • 删除OEM用户
  • 管理后台
    • 用户
      • 获取用户列表
      • 申请导出用户数据
      • 获取导出的用户数据
      • 取消用户数据导出申请
      • 获取数据申请记录
      • 获取数据下载记录
      • 搜索用户
      • 获取用户部门名称链
      • 修改用户详细信息
      • 修改用户安全信息
      • 解绑用户手机号\邮箱\第三方
    • 角色
      • 获取角色组列表
      • 新建角色组
      • 更新角色组
      • 设置角色组管理员
      • 添加用户至角色组
      • 从角色组移除用户
      • 为用户分配可读权限
      • 取消用户可读权限
    • 企业
      • 创建\修改企业
      • 创建\修改企业第三方关联
  • 其他
    • 企微第三方用户关联
    • 企微回调
    • 获取客户端配置
    • 获取RSA公钥
  1. 用户

修改用户基本信息

正式环境
https://accounts.zwsoft.cn
正式环境
https://accounts.zwsoft.cn
POST
/api/v1.0/users/basic
公开
最后修改时间:2023-02-22 03:11:51
需要scope:ZMS.UserBasic.Write 或 ZMS.UserDetails.Write
请求体中不需要修改的字段可省略或null。

请求参数

Header 参数
Authorization
string 
必需
示例值:
Bearer eyJhbGciB5DZtTWYVqa9A
Body 参数application/json
firstName
string  | null 
名字
可选
不可为纯空格,为空值时将被”-“ 替代
lastName
string  | null 
姓氏
可选
不可为纯空格,为空值时将被”-“ 替代
displayName
string  | null 
显示名称
可选
不可为空值,不可为纯空格
preferredLanguage
string  | null 
偏好语言
可选
标准语言代号,如:zh-CN
示例
{
    "firstName": "San",
    "lastName": "Zhang",
    "displayName": "San Zhang",
    "preferredLanguage": "en-US"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://accounts.zwsoft.cn/api/v1.0/users/basic' \
--header 'Authorization: Bearer eyJhbGciB5DZtTWYVqa9A' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "San",
    "lastName": "Zhang",
    "displayName": "San Zhang",
    "preferredLanguage": "en-US"
}'

返回响应

🟢200成功
application/json
Body
status
integer 
返回码
必需
详情请查看全局返回码
message
string 
错误详细信息
必需
无错误时,返回:success
error
string  | null 
错误代号
必需
详情请查看全局返回码
data
array[object (用户基本信息) {16}] 
返回数据
必需
无数据时为空列表
guid
string 
用户GUID
必需
userName
string 
用户名
必需
唯一,可用于索引用户
firstName
string  | null 
名字
必需
lastName
string  | null 
姓氏
必需
displayName
string 
显示名称
必需
profileImage
string 
头像链接
必需
已携带版本参数,若用户修改头像,则版本参数会自动变更
preferredLanguage
string 
偏好语言
必需
国际语言代号
itc
string  | null 
手机国别号
必需
phone
string  | null 
手机号
必需
仅当scope有phone时返回
email
string  | null 
邮箱
必需
仅当scope有email时返回
accountState
enum<string> 
账号状态
必需
枚举值:
NormalFreezeNotActive
securityStamp
string 
安全戳
必需
当安全戳改变时,表明用户进行了安全操作,需要重新登录
region
string  | null 
所属地区
必需
用户最常登录IP的国家或地区代码
isEmployee
boolean 
是否中望员工
必需
createTime
string 
注册时间
必需
lastLoginTime
string 
最后登录时间
必需
示例
{
    "status": 0,
    "message": "success",
    "error": null,
    "data": [
        {
            "guid": "1f83b588-aba3-4378-acd8-d59c71a8311d",
            "firstName": "Zhang",
            "lastName": "San",
            "displayName": "San Zhang",
            "profileImage": "https://resources.zwsoft.cn/prd/ZwsoftAccounts/public/userHeadImg/sA9Cu0XTpirK95LBLFzUJe-nIoxcLaYgnbJYUBzDRqDyKp6A9CzX8HUWX-ktyG-q/originalPic.png",
            "preferredLanguage": "en-US",
            "userName": "zhangsan",
            "phone": null,
            "email": "zhangsan@test.com",
            "itc": null,
            "accountState": "Normal"
        }
    ]
}
修改于 2023-02-22 03:11:51
上一页
获取用户基本信息
下一页
修改用户头像
Built with