Employee Identity (EIAM)

Update Personal Information Interface

Interface

This interface is called to update personal information after a user logs in successfully. This interface does not support modifying personal passwords, phone numbers, or email addresses.

# Request Description

Request URL https://{your_domain}/api/v2/sdk/profile/update

Request Method POST

Content-Type application/json

# Request Header Parameters

Parameter Chinese Name Required Type Example
X-operating-sys-version Caller Operating System Version Yes String windows10.1.1
X-device-fingerprint Caller Device Fingerprint Yes String 156aysdna213sc50
X-device-ip Caller IP No String 192.168.1.2
X-agent User-Agent Information Yes String Mozilla/5.0 (iPhone; CPU iPhone OS 13_3 like Mac OS X) AppleWebKit/605.1.15(KHTML, like Gecko)
Mobile/15E148/HuaWei-AnyOffice/2.6.1802.0010/com.huawei.cloudlink.workplace
X-L For Internationalization Language Setting No String zh
X-client-id Application Authorization ID Yes String nTo1eRIub60vPb54WeE6aojPwYwImtl4
Authorization The ID token returned by the user login interface. Format is Bearer {id_token} Yes String Bearer eyJraWQiOiI1ZWZhN2ZmZDA2Z...

# Request Body Example

{
  "user_name": "zhangsan",
  "name": "张三",
  "head_img": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTIQ8QOTSn3y4cYHLlMC3sv6RCBmeMkxtOog47Zr3v2Afbqc2bmP0WibUIUskX39eJlJAEbAibXs",
  "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

# Request Parameters

Parameter Name Chinese Name Required Type Description
user_name Username No String
name Full Name No String
head_img Avatar (URL) No String
attr_gender Gender No String Optional values: female: Female; male: Male; unknow: Undisclosed
attr_birthday Birthday No String Format: yyyy-MM-dd
attr_nick_name Nickname No String
mailing_address Mailing Address No String
zip_code Postal Code No String
first_name First Name No String
middle_name Middle Name No String
last_name Last Name No String
industry Industry No String
extension Extended Attributes No JSONObject Extended attributes must be defined in the Enterprise Center

# Response Example

Success Example:
HTTP/1.1 200 OK
Content-Type: application/json
Error Example:
HTTP/1.1 400 Bad Request
{
    "error_code": "SDK.COMMON.1001",
    "error_msg": "Parameter X-client-id cannot be left blank."
}
1
2
3
4
5
6
7
8
9

# Response Parameters

None