文档首页/ 应用身份管理服务 OneAccess/ API参考/ API/ 管理类接口/ 用户管理/ 修改用户
更新时间：2024-08-30 GMT+08:00
查看PDF
分享

修改用户

功能介绍

修改用户。

接口约束

无

URI

PUT /api/v2/tenant/users/{user_id}

表1 路径参数

参数

是否必选

参数类型

描述

user_id

是

String

用户id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

该字段内容填为“application/json;charset=utf8”。

Authorization

是

String

认证凭据，值：Bearer {access_token}，access_token通过“获取访问凭据”接口获取。
表3 请求Body参数

参数

是否必选

参数类型

描述

user_name

否

String

用户名，用户唯一标识，企业内唯一。

mobile

否

String

手机号，企业内唯一。

org_code

否

String

组织编码。

name

否

String

姓名。

email

否

String

邮箱。

employee_id

否

String

员工id。

first_name

否

String

名字。

middle_name

否

String

中间名。

last_name

否

String

姓氏。

pwd_must_modify

否

Boolean

首次登录是否需要强制修改密码。

缺省值：true

attr_gender

否

String

性别。

枚举值：

  • unknown：保密
  • male：男
  • female：女

attr_birthday

否

String

生日，格式为yyyy-mm-dd。

attr_nick_name

否

String

昵称。

attr_identity_type

否

String

证件类型。

枚举值：

  • id_card：居民身份证
  • HongKong_Macau_Taiwan_residence_permit：港澳台居住证
  • mainland_travel_permit_for_HongKong_Macao：港澳居民来往内地通行证
  • mainland_travel_permit_for_Taiwan：台湾居民来往大陆通行证
  • chinese_passport：中国护照
  • overseas_passport：海外驾照
  • overseas_driver_license：海外驾照
  • officer_id：军官证
  • foreigner_residence_permit：外国人居留证
  • other：其他

attr_identity_number

否

String

证件号码。

attr_area

否

String

国家或者地区的编码。

attr_city

否

String

城市。

attr_manager_id

否

String

直属上级。

attr_user_type

否

String

人员类型。

枚举值：

  • regular：正式
  • intern：实习
  • dispatch：劳务派遣
  • outsourcing：劳务外包

attr_hire_date

否

String

入职时间，格式为yyyy-MM-dd。

attr_work_place

否

String

工作地点。

user_org_relation_list

否

UserOrgRelationListOption object

用户组织关系集合。若填写，必须包含主组织的信息。

extension

否

Object

自定义扩展属性。
表4 UserOrgRelationListOption

参数

是否必选

参数类型

描述

orgCode

是

String

组织编码

relationType

是

String

归属关系，同一用户只能有1个归属，最多9个挂靠。

枚举值：

  • 0：挂靠
  • 1：归属

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

user_id

String

用户id。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误编号。

error_msg

String

错误详情。

请求示例

修改用户，用户名zhangsan，手机号12345678901，邮箱zhangsan@example.com。

PUT https://{domain_name}/api/v2/tenant/users/{user_id}

Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140...

{
    "user_name": "zhangsan",
    "org_code": "10000",
    "name": "zhangsan",
    "mobile": "12345678901",
    "email": "zhangsan@example.com",
    "employee_id": "123456789",
    "pwd_must_modify": false,
    "first_name": "F",
    "middle_name": "M",
    "last_name": "L",
    "attr_gender": "male",
    "attr_birthday": "1990-02-01",
    "attr_nick_name": "zhangsan",
    "attr_identity_type": "id_card",
    "attr_identity_number": "123456789",
    "attr_area": "CN",
    "attr_city": "xxx",
    "attr_manager_id": "123456789",
    "attr_user_type": "regular",
    "attr_hire_date": "2021-04-01",
    "attr_work_place": "xxx",
    "user_org_relation_list": [
     {
            "orgCode": "10000",
            "relationType": 1
      },
      {
            "orgCode": "TestOrg1",
            "relationType": 0
      },
      {
            "orgCode": "TestOrg2",
            "relationType": 0
      }
    ],
    "extension": {
        "age": "18"
    }
}

响应示例

状态码： 200

请求成功。

{
  "user_id" : "20210621095935811-5E16-6B3060..."
}

状态码

状态码

描述

200

请求成功。

400

参数无效。

错误码

请参见错误码。

父主题： 用户管理

相关文档