Update My Avatar
Sets or switches the avatar of the current user.
Request URL
POST {base_url}/uc-user/api/v1/accounts/me/avatar
Request parameters
- Headers
-
Parameter Required Type Description Authorization Yes String The access token used for authentication. Format: Bearer
{access_token}.x-tenant-code No String The tenant name. Note: You can obtain tenant name using the Query Tenants interface.
- Body parameters
-
Parameter Required Type Description resourceId Yes Integer The resource ID of the avatar. Upload the avatar file to the resource service first and pass in the returned resource ID.
Response parameters
| Parameter | Type | Description |
|---|---|---|
| requestId | String | The unique ID of the request, which can be used to quickly locate the request. |
| code | String | The HTTP status code of the request.
|
| message | String | The status message of the request. |
| detailMessage | String | The detailed error information. When the request is successful, this parameter returns empty. |
| result | Object<User_Detail> | The details of the current user after the avatar is updated. |
- User_Detail
-
Parameter Type Description id String The ID of the user. ucId String The UC ID of the company that the user belongs to. email String The email address. username String The username, which is used for login. company String The company name. region String The region that the user belongs to. country String The country name synchronized from PP, such as United States. tenantCode String The code of the tenant that the user belongs to. userType String The type of the user:
P_ACCOUNT: The platform user.T_USER: The tenant user.
subType String The sub type of the user:
SUPER: The super administrator.ADMIN: The administrator.RESELLER: The reseller.
This parameter is valid only for P_ACCOUNT.
isPrimaryAccount Boolean Whether the account is a primary account. true indicates a primary account, and false indicates a colleague account. ownerId Integer The ID of the primary account. This parameter is returned only for colleague accounts of P_ACCOUNT and points to the primary account. roleId Integer The role ID. boundUserId Integer The ID of the bound tenant user. This parameter is valid only for P_ACCOUNT and stores the ID of the bound T_USER. boundAccountId Integer The ID of the bound platform account. This parameter is valid only for T_USER and stores the ID of the bound P_ACCOUNT. extension String The extension number. This parameter is valid only for T_USER and is extracted from the part before @ in the username (extCode@tenantCode). isTenantAdmin Boolean Whether the user is a tenant administrator. This parameter is true when the user has the tenant administrator role (role ID 102). status String The status of the account. nickname String The nickname of the user. firstName String The first name of the user. lastName String The last name of the user. lastLoginTime Integer The time of the last login, in Unix timestamp format (milliseconds). createTime Integer The time when the account was created, in Unix timestamp format (milliseconds). updateTime Integer The time when the account was last updated, in Unix timestamp format (milliseconds). tenantOemId Integer The default OEM ID used when creating a tenant. The value 0 indicates the standard edition. mfaEnabled Boolean Whether MFA (2FA) is enabled. profileImage String The URL of the avatar (a permanent public link of the resource).
Example
Request example
POST /uc-user/api/v1/accounts/me/avatar HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJtdDEwMDBAbWFpbHN0YXIudG9wIiwiYXBwX2tleSI6Im9icWJUSWd1ZkJ5d3ZCNmF0VURmVDZpeDJvUlhUb0wzIiwiZ3JhbnRfdHlwZSI6Im9wZW5hcGkiLCJjbGllbnRfZXh0Ijp7ImRlc2NyaXB0aW9uIjoi56ys5LiJ5pa55ZCI5L2c5LyZ5Ly05bqU55SoIiwicGFydG5lciI6IuekuuS-i-WQiOS9nOS8meS8tCJ9LCJjbGllbnRfdHlwZSI6Im9wZW5hcGkiLCJleHAiOjE3OTIwNzI3NTcsImlhdCI6MTc5MjA1MTE1NywianRpIjoiOTVkOGM1YWMtNzg3MS00ZjlmLWFiOWUtYzFjOTBlYzU4N2M1IiwiY2xpZW50X2lkIjoibm92by1vcGVuLXBsYXRmb3JtIiwidXNlcl9leHQiOnsicm9sZUlkcyI6WzNdLCJzdHlwZSI6IkFETUlOIiwidGVuYW50Q29kZSI6bnVsbCwidHlwZSI6IlBfQUNDT1VOVCIsInVzZXJJZCI6MjA4NTMxNTk0ODg0OTgyNzg0MiwiZW1haWwiOiJtdDEwMDBAbWFpbHN0YXIudG9wIiwidXNlcm5hbWUiOiJtdDEwMDBAbWFpbHN0YXIudG9wIiwidWNJZCI6MjA4NTMxNTk0ODI4Nzc5MTEwNn19.AmC_hWm0Pa51VbO2YaQZF3gXofw5NQDi_njH-fPAi2r_kWc8PyxkK6vq212lTPHR-eDMY3CaXhUxptGNcUUXAHfbuFqHXBcLvZ1ggmMCYLlSpcsj9TBg3BULyvHOlJBEbO7b_OOBZi_fGG-Oe3e9m-EsdOjA150ZJKU9trq-QUqFndTvdMZV9JHDV2xpDwgKdT6v4xNhM9TaAT9_tLmOtSipIijx32ng8CIDd0l7jWYfrmwsjf32n0P232nXmKfdADjSuKAp8TNxc17ccFxt9k0aQlB9uyhGPjIdCHSK7hill2VbzVAGuVzj3b1AplQz2cAVmVhXqWqOfpfjM1tY9A
Content-Type: application/json
{
"resourceId": 2110642741495742465
}
Response example
HTTP/1.1 200 OK { "result": { "id": "2085315948849827842", "ucId": "2085315948287791106", "email": "mt1000@mailstar.top", "username": "mt1000@mailstar.top", "company": "", "userType": "P_ACCOUNT", "subType": "ADMIN", "isPrimaryAccount": true, "status": "ACTIVE", "firstName": "Admin", "lastName": "Admin", "createTime": 1786013040167, "updateTime": 1792051339607, "tenantOemId": 84, "mfaEnabled": false, "profileImage": "https://tst-client-hosted-0-business-992382618242-ap-east-1-an.s3.ap-east-1.amazonaws.com/public/platform/_GLOBAL/user_avatar/1790664273763/avatar.png" }, "requestId": "db3a5c4b658e4cd1b754a5725480c6a8", "code": "200", "message": "SUCCESS" }
Note:
Before calling this API, upload the avatar file to the resource service using the upload credential obtained from the avatar upload credential API, and pass in the returned resourceId.