中望帐号
  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列表
        GET
      • 批量查询用户GUID
        POST
      • 批量获取用户详细信息
        POST
      • 批量获取用户第三方绑定信息
        POST
      • 通过第三方登录信息查询用户
        POST
      • 创建用户
        POST
      • 查询最近的登录记录
        GET
      • 增加用户第三方绑定信息
        POST
      • 批量修改用户详细信息
        POST
    • 企业
      • 刷新企业用户部门
    • 其他
      • 推送服务消息
  • OEM受信客户端
    • OEM授权认证对接说明
    • 获取OEM用户列表
    • 注册OEM用户
    • 更新OEM用户
    • 删除OEM用户
  • 管理后台
    • 用户
      • 获取用户列表
      • 申请导出用户数据
      • 获取导出的用户数据
      • 取消用户数据导出申请
      • 获取数据申请记录
      • 获取数据下载记录
      • 搜索用户
      • 获取用户部门名称链
      • 修改用户详细信息
      • 修改用户安全信息
      • 解绑用户手机号\邮箱\第三方
    • 角色
      • 获取角色组列表
      • 新建角色组
      • 更新角色组
      • 设置角色组管理员
      • 添加用户至角色组
      • 从角色组移除用户
      • 为用户分配可读权限
      • 取消用户可读权限
    • 企业
      • 创建\修改企业
      • 创建\修改企业第三方关联
  • 其他
    • 企微第三方用户关联
    • 企微回调
    • 获取客户端配置
    • 获取RSA公钥
  1. 用户

创建用户

正式环境
https://accounts.zwsoft.cn
正式环境
https://accounts.zwsoft.cn
POST
/api/v1.0/users/inviteUsers
公开
最后修改时间:2024-06-03 09:17:41
需要scope:ZMS.Users.Create
批量邀请用户请使用邀请用户接口(邀请后需要用户注册)
每次请求不超过50名用户;不建议一次邀请太多用户,每名用户需要2~3秒
用户不存在则进行创建,若创建成功或用户已存在,则返回用户信息。
每个邀请信息会单独返回相应的标准错误信息和用户信息。

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Header 参数
Authorization
string 
必需
示例值:
Bearer eyJhbGciB5DZtTWYVqa9A
Body 参数application/json
array of:
phone
string 
手机号
可选
手机或邮箱必须有一项
email
string 
邮箱
可选
手机或邮箱必须有一项
userName
string 
用户名
可选
支持英文大小写字母、数字、'.'、'_'、'-';默认email前缀或手机号,若不符合要求则自动生成随机用户名
>= 6 字符<= 16 字符
ITC
string 
国际手机区号
可选
accountState
enum<string> 
账号状态
可选
枚举值:
NormalFreezeNotActive
默认值:
Normal
password
string 
密码
可选
必须包括英文大小写字母、数字、英文符号
>= 8 字符<= 32 字符
firstName
string 
名字
可选
lastName
string 
姓氏
可选
displayName
string 
显示名称
可选
默认email前缀\手机号\用户名
preferredLanguage
string 
偏好语言
可选
国际语言代号
department
string 
部门名称
可选
示例
[
    {
        "phone": "17600001113",
        "email": "test1113@test.cn",
        "password": "Zwsoft.1113",
        "ITC": "+86",
        "accountState": "Normal",
        "userName": "test1113",
        "firstName": "1113",
        "lastName": "test",
        "displayName": "test1113",
        "preferredLanguage": "zh-CN"
    },
    {
        "phone": "17600001114",
        "email": "testa@test.cn",
        "password": "Zwsoft.1114",
        "ITC": "+86"
    },
    {
        "phone": "17600001114",
        "email": "test1114@test.cn",
        "password": "Zwsoft",
        "ITC": "+86"
    }
]  

示例代码

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/inviteUsers' \
--header 'Authorization: Bearer eyJhbGciB5DZtTWYVqa9A' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "phone": "17600001113",
        "email": "test1113@test.cn",
        "password": "Zwsoft.1113",
        "ITC": "+86",
        "accountState": "Normal",
        "userName": "test1113",
        "firstName": "1113",
        "lastName": "test",
        "displayName": "test1113",
        "preferredLanguage": "zh-CN"
    },
    {
        "phone": "17600001114",
        "email": "testa@test.cn",
        "password": "Zwsoft.1114",
        "ITC": "+86"
    },
    {
        "phone": "17600001114",
        "email": "test1114@test.cn",
        "password": "Zwsoft",
        "ITC": "+86"
    }
]'

返回响应

🟢200成功
application/json
Body
status
integer 
返回码
必需
详情请查看全局返回码
message
string 
错误详细信息
必需
无错误时,返回:success
error
string  | null 
错误代号
必需
详情请查看全局返回码
data
array [object {2}] 
返回数据
必需
无数据时为空列表
error
object  | null 
错误信息
必需
userInfo
用户信息
必需
示例
{
    "status": 0,
    "message": "success",
    "error": null,
    "data": [
        {
            "error": null,
            "userInfo": {
                "guid": "2c24af21-9436-446d-89cd-77b22a778a0c",
                "firstName": "1113",
                "lastName": "test",
                "displayName": "test1113",
                "profileImage": "https://test.resources.zwsoft.cn/prd/ZwsoftAccounts/public/userHeadImg/I5GjkLyAwHaLeDk9pi6027udwE8ZyJSz_JtLM6qExcPo-BAjnhvXWi0jKLE_PKhq/originalPic.png",
                "preferredLanguage": "zh-CN",
                "itc": "+86",
                "phone": "17600001113",
                "email": "test1113@test.cn",
                "accountState": "Normal"
            }
        },
        {
            "error": {
                "status": 50001,
                "message": "Email Already Exist",
                "error": "CreateUserFailed",
                "data": null
            },
            "userInfo": {
                "guid": "22d28143-bcc0-4772-9fa4-80df82f550eb",
                "firstName": "a",
                "lastName": "test",
                "displayName": "testa",
                "profileImage": "https://test.resources.zwsoft.cn/prd/ZwsoftAccounts/public/userHeadImg/FlI1Fy1Y2_sfWpuqoBtyXdY9XdPVNQ9ty0lPSYBujQ6js8X7IAKTkGVvLtxRQJij/originalPic.png",
                "preferredLanguage": "zh-CN",
                "itc": "+86",
                "phone": "17645678903",
                "email": "testa@test.cn",
                "accountState": "Normal"
            }
        },
        {
            "error": {
                "status": 50007,
                "message": "Password Unqualified",
                "error": "CreateUserFailed",
                "data": null
            },
            "userInfo": null
        }
    ]
}
🟢200自动化专用
修改于 2024-06-03 09:17:41
上一页
通过第三方登录信息查询用户
下一页
查询最近的登录记录
Built with