客户身份(CIAM)
修改用户部分属性
# 请求说明
PUT https://{your_domain}/api/v2/tenant/users/{user_id}
# 请求头
| 参数名 | 中文名称 | 必须 | 类型 | 描述 |
|---|---|---|---|---|
| Authorization | 授权 | 是 | String | 格式：Bearer {access_token} |
| Content-Type | 内容类型 | 是 | String | 固定值：application/json; charset=utf-8 |
# 请求示例
修改用户的姓名示例
{
"name": "张三"
}
修改用户名、姓名、手机、邮箱、扩展属性等示例
{
"user_name":"zhangsan",
"name":"张三",
"mobile":"15200000000",
"email":"15200000000@qq.com",
"head_img": "data:image/jpeg;base64,......."
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
根据请求的用户ID参数更新用户的身份信息，支持更新部分用户属性。如请求参数只包含用户姓名时，系统仅更新用户的姓名，其他用户属性不变。
# 请求参数
| 参数名 | 中文名称 | 必须 | 类型 | 描述 |
|---|---|---|---|---|
| user_name | 用户名 | 否 | String | 用户名，用户在企业内部的唯一标识，可以在请求参数中指定，如果不传该参数，系统将自动生成 |
| name | 姓名 | 否 | String | |
| mobile | 手机号 | 否 | String | |
| 邮箱 | 否 | String | ||
| attr_gender | 性别 | 否 | String | 可选值有： "unknow":保密 "male":男 "female":女 |
| attr_birthday | 生日 | 否 | String | 格式为： yyyy-mm-dd |
| attr_nick_name | 昵称 | 否 | String | |
| mailing_address | 邮寄地址 | 否 | String | |
| zip_code | 邮政编码 | 否 | String | |
| first_name | 名字 | 否 | String | |
| middle_name | 中间名 | 否 | String | |
| last_name | 姓氏 | 否 | String | |
| industry | 所属行业 | 否 | String | |
| extension | 扩展属性 | 否 | JSONObject | 扩展属性，扩展的属性需要在企业中定义 |
| head_img | 用户头像 | 否 | String | 用户头像，支持base 64编码的图片字符串和http、https开头的url |
注：企业可根据实际需要在“企业中心-用户属性定义”对系统内置的属性修改是否必填及展示名称（不能删除系统属性），也可以根据企业需求扩展用户属性，接口请求参数以“用户属性定义”模块中定义的属性进行处理。
# 返回示例
成功示例：
HTTP/1.1 200 OK
Content-Type: application/json
{
"user_id": "20201028102749564-9082-DC8CD2722"
}
错误示例：
HTTP/1.1 400 Bad Request
{
"error_msg": "User not found",
"error_code": "IDAAS.TENANT.USER.0001"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
# 返回参数
| 参数名 | 中文名称 | 类型 | 描述 |
|---|---|---|---|
| user_id | 用户id | String |
# 错误码
| 状态码 | 错误码 | 错误信息 | 处理措施 |
|---|---|---|---|
| 400 | IDAAS.TENANT.USER.0001 | User not found | 请检查对应用户是否存在 |
| 用户未找到 | |||
| 400 | IDAAS.TENANT.USER.0002 | Username cannot be empty | 请检查入参中的用户名字段是否为空 |
| 用户名不能为空 | |||
| 400 | IDAAS.TENANT.USER.0003 | Name cannot be empty | 请检查入参中的姓名字段是否为空 |
| 姓名不能为空 | |||
| 400 | IDAAS.TENANT.USER.0004 | Mobile number cannot be empty | 请检查入参中的手机号字段是否为空 |
| 手机号不能为空 | |||
| 400 | IDAAS.TENANT.USER.0005 | E-mail cannot be empty | 请检查入参中的邮箱字段是否为空 |
| 邮箱不能为空 | |||
| 400 | IDAAS.TENANT.USER.0007 | Gender cannot be empty | 请检查入参中的性别字段是否为空 |
| 性别不能为空 | |||
| 400 | IDAAS.TENANT.USER.0008 | Birthday cannot be empty | 请检查入参中的生日字段是否为空 |
| 生日不能为空 | |||
| 400 | IDAAS.TENANT.USER.0009 | Nick name cannot be empty | 请检查入参中的昵称字段是否为空 |
| 昵称不能为空 | |||
| 400 | IDAAS.TENANT.USER.0010 | Mailing address cannot be empty | 请检查入参中的邮寄地址字段是否为空 |
| 邮寄地址不能为空 | |||
| 400 | IDAAS.TENANT.USER.0011 | Zip code cannot be empty | 请检查入参中的邮政编码字段是否为空 |
| 邮政编码不能为空 | |||
| 400 | IDAAS.TENANT.USER.0012 | First name cannot be empty | 请检查入参中的名字字段是否为空 |
| 名字不能为空 | |||
| 400 | IDAAS.TENANT.USER.0013 | Middle name cannot be empty | 请检查入参中的中间名字段是否为空 |
| 中间名不能为空 | |||
| 400 | IDAAS.TENANT.USER.0014 | Last name cannot be empty | 请检查入参中的姓氏字段是否为空 |
| 姓氏不能为空 | |||
| 400 | IDAAS.TENANT.USER.0015 | Industry cannot be empty | 请检查入参中的所属行业字段是否为空 |
| 所属行业不能为空 | |||
| 400 | IDAAS.TENANT.USER.0017 | Extended property {0} cannot be empty | 请检查入参中的外部ID字段是否为空 |
| 扩展属性{0}不能为空 | |||
| 400 | IDAAS.TENANT.USER.0018 | The username does not meet the verification rules | 请检查入参中的用户名字段是否符合【企业中心-用户-用户属性定义】中用户名字段的校验规则 |
| 用户名不符合校验规则 | |||
| 400 | IDAAS.TENANT.USER.0019 | The name does not meet the verification rules | 请检查入参中的姓名字段是否符合【企业中心-用户-用户属性定义】中姓名字段的校验规则 |
| 姓名不符合校验规则 | |||
| 400 | IDAAS.TENANT.USER.0020 | The mobile number does not meet the verification rules | 请检查入参中的手机号字段是否符合【企业中心-用户-用户属性定义】中手机号字段的校验规则 |
| 手机号不符合校验规则 | |||
| 400 | IDAAS.TENANT.USER.0021 | The e-mail does not meet the verification rules | 请检查入参中的邮箱字段是否符合【企业中心-用户-用户属性定义】中邮箱字段的校验规则 |
| 邮箱不符合校验规则 | |||
| 400 | IDAAS.TENANT.USER.0023 | The gender does not meet the verification rules | 请检查入参中的性别字段是否符合【企业中心-用户-用户属性定义】中性别字段的校验规则 |
| 性别不符合校验规则 | |||
| 400 | IDAAS.TENANT.USER.0024 | The birthday does not meet the verification rules | 请检查入参中的生日字段是否符合【企业中心-用户-用户属性定义】中生日字段的校验规则 |
| 生日不符合校验规则 | |||
| 400 | IDAAS.TENANT.USER.0025 | The nickname does not meet the verification rules | 请检查入参中的昵称字段是否符合【企业中心-用户-用户属性定义】中昵称字段的校验规则 |
| 昵称不符合校验规则 | |||
| 400 | IDAAS.TENANT.USER.0026 | The mailing address does not meet the verification rules | 请检查入参中的邮寄地址字段是否符合【企业中心-用户-用户属性定义】中邮寄地址字段的校验规则 |
| 邮寄地址不符合校验规则 | |||
| 400 | IDAAS.TENANT.USER.0027 | The zip code does not meet the verification rules | 请检查入参中的邮政编码字段是否符合【企业中心-用户-用户属性定义】中生日字段的校验规则 |
| 邮政编码不符合校验规则 | |||
| 400 | IDAAS.TENANT.USER.0028 | The first name does not meet the verification rules | 请检查入参中的名字字段是否符合【企业中心-用户-用户属性定义】中名字字段的校验规则 |
| 名字不符合校验规则 | |||
| 400 | IDAAS.TENANT.USER.0029 | The middle name does not meet the verification rules | 请检查入参中的中间名字段是否符合【企业中心-用户-用户属性定义】中中间名字段的校验规则 |
| 中间名不符合校验规则 | |||
| 400 | IDAAS.TENANT.USER.0030 | The last name does not meet the verification rules | 请检查入参中的姓氏字段是否符合【企业中心-用户-用户属性定义】中姓氏字段的校验规则 |
| 姓氏不符合校验规则 | |||
| 400 | IDAAS.TENANT.USER.0031 | The industry does not meet the verification rules | 请检查入参中的所属行业字段是否符合【企业中心-用户-用户属性定义】中所属行业字段的校验规则 |
| 所属行业不符合校验规则 | |||
| 400 | IDAAS.TENANT.USER.0033 | The extended attribute {0} does not meet the verification rules | 请检查入参中的外部ID字段是否符合【企业中心-用户-用户属性定义】中外部ID字段的校验规则 |
| 扩展属性{0}不符合校验规则 | |||
| 400 | IDAAS.TENANT.MOBILE.0002 | An unauthenticated cell mobile number | 请检查【企业中心-企业配置-国际区号配置】是否符合配置规则 |
| 未经认证的手机号 | |||
| 400 | IDAAS.TENANT.USER.0034 | Username already exists | 请检查用户是否存在 |
| 用户名已存在 | |||
| 400 | IDAAS.TENANT.USER.0035 | Mobile number already exists | 删除手机号重新添加或更换未添加过的手机号。 |
| 手机号已存在 | |||
| 400 | IDAAS.TENANT.USER.0036 | E-mail already exists | 删除邮箱重新添加或更换未添加过的邮箱。 |
| 邮箱已存在 | |||
| 400 | IDAAS.TENANT.USER.0037 | Extended property {0} already exists | 删除扩展属性{0}重新添加或更换未添加过的扩展属性{0}。 |
| 扩展属性{0}已存在 |