Customer Identity (CIAM)
Update Personal Information
This interface is called when a user modifies their personal information after successful login. This interface does not support modifying personal passwords, phone numbers, or email addresses.
This is a post-login interface. Authentication information must be added to the header: Authorization
# Request Specification
POST https://{your_domain}/api/v2/sdk/profile/update
# Request Headers
| Parameter Name | Chinese Name | Required | Type | Example |
|---|---|---|---|---|
| X-operating-sys-version | Calling Client OS Version | Yes | String | windows10.1.1 |
| X-device-fingerprint | Calling Client Device Fingerprint | Yes | String | 156aysdna213sc50 |
| X-device-ip | Calling Client 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) |
| X-L | For Internationalization Language Setting | No | String | zh |
| X-client-id | Application Authorization ID | Yes | String | nTo1eRIub60vPb54WeE6aojPwYwImtl4 |
| Authorization | Authorization Information | Yes | String | Bearer {id_token} |
| content-type | Content Format Type | Yes | String | application/json |
# Request Example
{
"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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# Request Parameters
| Parameter | Chinese Name | Required | Type | Description |
|---|---|---|---|---|
| user_name | Username | No | String | |
| name | Name | No | String | |
| head_img | Avatar (URL) | No | String | |
| attr_gender | Gender | No | String | Options: female: female; male: male; unknow: confidential |
| 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 | Extension Attributes | No | JSONObject | Extension attributes must be defined within the enterprise |
# Response Example
Success Example:
HTTP/1.1 200 OK
Content-Type: application/json
Error Example:
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
2
3
4
5
6
7
8
9
10
11
# Response Parameters
None
# Error Codes
| Status Code | Error Code | Error Message | Handling Measure |
|---|---|---|---|
| 400 | IDAAS.SDK.USER.0018 | The username does not meet the verification rules | Please check if the username field in the input parameters complies with the validation rules for the username field in 【Enterprise Center - User - User Attribute Definition】 |
| Username does not meet validation rules | |||
| 400 | IDAAS.SDK.USER.0019 | The name does not meet the verification rules | Please check if the name field in the input parameters complies with the validation rules for the name field in 【Enterprise Center - User - User Attribute Definition】 |
| Name does not meet validation rules | |||
| 400 | IDAAS.SDK.USER.0023 | The gender does not meet the verification rules | Please check if the gender field in the input parameters complies with the validation rules for the gender field in 【Enterprise Center - User - User Attribute Definition】 |
| Gender does not meet validation rules | |||
| 400 | IDAAS.SDK.USER.0024 | The birthday does not meet the verification rules | Please check if the birthday field in the input parameters complies with the validation rules for the birthday field in 【Enterprise Center - User - User Attribute Definition】 |
| Birthday does not meet validation rules | |||
| 400 | IDAAS.SDK.USER.0025 | The nickname does not meet the verification rules | Please check if the nickname field in the input parameters complies with the validation rules for the nickname field in 【Enterprise Center - User - User Attribute Definition】 |
| Nickname does not meet validation rules | |||
| 400 | IDAAS.SDK.USER.0026 | The mailing address does not meet the verification rules | Please check if the mailing address field in the input parameters complies with the validation rules for the mailing address field in 【Enterprise Center - User - User Attribute Definition】 |
| Mailing address does not meet validation rules | |||
| 400 | IDAAS.SDK.USER.0027 | The zip code does not meet the verification rules | Please check if the zip code field in the input parameters complies with the validation rules for the birthday field in 【Enterprise Center - User - User Attribute Definition】 |
| Zip code does not meet validation rules | |||
| 400 | IDAAS.SDK.USER.0028 | The first name does not meet the verification rules | Please check if the first name field in the input parameters complies with the validation rules for the first name field in 【Enterprise Center - User - User Attribute Definition】 |
| First name does not meet validation rules | |||
| 400 | IDAAS.SDK.USER.0029 | The middle name does not meet the verification rules | Please check if the middle name field in the input parameters complies with the validation rules for the middle name field in 【Enterprise Center - User - User Attribute Definition】 |
| Middle name does not meet validation rules | |||
| 400 | IDAAS.SDK.USER.0030 | The last name does not meet the verification rules | Please check if the last name field in the input parameters complies with the validation rules for the last name field in 【Enterprise Center - User - User Attribute Definition】 |
| Last name does not meet validation rules | |||
| 400 | IDAAS.SDK.USER.0031 | The industry does not meet the verification rules | Please check if the industry field in the input parameters complies with the validation rules for the industry field in 【Enterprise Center - User - User Attribute Definition】 |
| Industry does not meet validation rules | |||
| 400 | IDAAS.SDK.USER.0033 | The extended attribute {0} does not meet the verification rules | Please check if the extended attribute {0} field in the input parameters complies with the validation rules for the extended attribute {0} field in 【Enterprise Center - User - User Attribute Definition】 |
| Extended attribute {0} does not meet validation rules | |||
| 400 | IDAAS.SDK.USER.0034 | Username already exists | Please check if the user exists |
| Username already exists | |||
| 400 | IDAAS.SDK.USER.0037 | Extended property {0} already exists | Delete extended property {0} and re-add it, or replace it with an extended property {0} that has not been added before. |
| Extended property {0} already exists | |||
| 400 | IDAAS.SDK.PARAM.0001 | Device information is incomplete | Please check if the entered device information is complete |
| Device information is incomplete | |||
| 400 | IDAAS.SDK.PARAM.0002 | clientId cannot be empty | Please check if the entered clientId is empty |
| clientId cannot be empty | |||
| 400 | IDAAS.SDK.PARAM.0003 | The app is not registered, please register the app first | Please check if the entered clientId is correct |
| App is not registered, please register the app first | |||
| 400 | IDAAS.SDK.PARAM.0015 | IdToken cannot be empty | Please check if the entered IdToken is empty |
| IdToken cannot be empty | |||
| 400 | IDAAS.SDK.PARAM.0016 | IdToken is invalid or expired | Please try again after re-obtaining the IdToken |
| IdToken is invalid or has expired | |||
| 400 | IDAAS.SDK.USER.0001 | User not found | Please try again after registering |
| User not found |
Please provide the Markdown content you would like me to translate.