客户身份(CIAM)

修改个人信息

用户登录成功后修改个人信息时调用本接口,本接口不支持修改个人密码、手机号、邮箱。

此接口为登录后的接口,需要在header中添加鉴权信息:Authorization

# 请求说明

POST https://{your_domain}/api/v2/sdk/profile/update

# 请求头

参数名 中文名称 必须 类型 示例
X-operating-sys-version 调用方客户端操作系统版本 String windows10.1.1
X-device-fingerprint 调用方客户端设备指纹 String 156aysdna213sc50
X-device-ip 调用方客户端IP String 192.168.1.2
X-agent User-Agent信息 String Mozilla/5.0 (iPhone; CPU iPhone OS 13_3 like Mac OS X)
X-L 用于国际化语言设置 String zh
X-client-id 应用授权ID String nTo1eRIub60vPb54WeE6aojPwYwImtl4
Authorization 授权信息 String Bearer {id_token}
content-type 内容格式类型 String application/json

# 请求示例

{
    "user_name": "zhangsan", 
    "name": "张三", 
    "head_img": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTIQ8QOTbqc2bmP0WibUIUskX39eJlJAEbAibXs", 
    "attr_gender": "male", 
    "attr_birthday": "2022-02-17", 
    "attr_nick_name": "张三", 
    "mailing_address": "湖北省武汉市", 
    "zip_code": "430000", 
    "first_name": "zhangsan", 
    "middle_name": "zhangsan", 
    "last_name": "zhangsan", 
    "industry": "事业单位", 
    "extension": {
        "age": "18"
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# 请求参数

参数名 中文名称 必须 类型 描述
user_name 用户名 String
name 姓名 String
head_img 头像(url) String
attr_gender 性别 String 可选值有: female:女性; male:男性; unknow:保密
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 扩展属性需要在企业中定义

# 返回示例

成功示例:
HTTP/1.1 200 OK
Content-Type: application/json


错误示例:
HTTP/1.1 400 Bad Request
{
    "error_code": "IDAAS.SDK.PARAM.0016",
    "error_msg": "IdToken is invalid or expired"
}
1
2
3
4
5
6
7
8
9
10
11

# 返回参数

# 错误码

状态码 错误码 错误信息 处理措施
400 IDAAS.SDK.USER.0018 The username does not meet the verification rules 请检查入参中的用户名字段是否符合【企业中心-用户-用户属性定义】中用户名字段的校验规则
用户名不符合校验规则
400 IDAAS.SDK.USER.0019 The name does not meet the verification rules 请检查入参中的姓名字段是否符合【企业中心-用户-用户属性定义】中姓名字段的校验规则
姓名不符合校验规则
400 IDAAS.SDK.USER.0023 The gender does not meet the verification rules 请检查入参中的性别字段是否符合【企业中心-用户-用户属性定义】中性别字段的校验规则
性别不符合校验规则
400 IDAAS.SDK.USER.0024 The birthday does not meet the verification rules 请检查入参中的生日字段是否符合【企业中心-用户-用户属性定义】中生日字段的校验规则
生日不符合校验规则
400 IDAAS.SDK.USER.0025 The nickname does not meet the verification rules 请检查入参中的昵称字段是否符合【企业中心-用户-用户属性定义】中昵称字段的校验规则
昵称不符合校验规则
400 IDAAS.SDK.USER.0026 The mailing address does not meet the verification rules 请检查入参中的邮寄地址字段是否符合【企业中心-用户-用户属性定义】中邮寄地址字段的校验规则
邮寄地址不符合校验规则
400 IDAAS.SDK.USER.0027 The zip code does not meet the verification rules 请检查入参中的邮政编码字段是否符合【企业中心-用户-用户属性定义】中生日字段的校验规则
邮政编码不符合校验规则
400 IDAAS.SDK.USER.0028 The first name does not meet the verification rules 请检查入参中的名字字段是否符合【企业中心-用户-用户属性定义】中名字字段的校验规则
名字不符合校验规则
400 IDAAS.SDK.USER.0029 The middle name does not meet the verification rules 请检查入参中的中间名字段是否符合【企业中心-用户-用户属性定义】中中间名字段的校验规则
中间名不符合校验规则
400 IDAAS.SDK.USER.0030 The last name does not meet the verification rules 请检查入参中的姓氏字段是否符合【企业中心-用户-用户属性定义】中姓氏字段的校验规则
姓氏不符合校验规则
400 IDAAS.SDK.USER.0031 The industry does not meet the verification rules 请检查入参中的所属行业字段是否符合【企业中心-用户-用户属性定义】中所属行业字段的校验规则
所属行业不符合校验规则
400 IDAAS.SDK.USER.0033 The extended attribute {0} does not meet the verification rules 请检查入参中的扩展属性{0}字段是否符合【企业中心-用户-用户属性定义】中扩展属性{0}字段的校验规则
扩展属性{0}不符合校验规则
400 IDAAS.SDK.USER.0034 Username already exists 请检查用户是否存在
用户名已存在
400 IDAAS.SDK.USER.0037 Extended property {0} already exists 删除扩展属性{0}重新添加或更换未添加过的扩展属性{0}。
扩展属性{0}已存在
400 IDAAS.SDK.PARAM.0001 Device information is incomplete 请检查输入的设备信息是否完整
设备信息不完整
400 IDAAS.SDK.PARAM.0002 clientId cannot be empty 请检查输入的clientId是否为空
clientId不能为空
400 IDAAS.SDK.PARAM.0003 The app is not registered, please register the app first 请检查输入的clientId是否正确
应用未注册,请先注册应用
400 IDAAS.SDK.PARAM.0015 IdToken cannot be empty 请检查输入的IdToken是否为空
IdToken不能为空
400 IDAAS.SDK.PARAM.0016 IdToken is invalid or expired 请重新获取IdToken后再试
IdToken无效或已过期
400 IDAAS.SDK.USER.0001 User not found 请先注册后再试
用户未找到