Get an Account

Gets the details of an account.

Request URL

GET {base_url}/uc-user/api/v1/accounts/{id}

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.
Path parameters
Parameter Required Type Description
id Yes String The ID of the account. You can obtain the ID using the Search Resellers interface.

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.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
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<Account_Detail> The details of the account.
Account_Detail
Parameter Type Description
id String The ID of the account.
ucId String The UC ID of the company that the account belongs to.
subType String

The sub type of the user:

  • SUPER: The super administrator.
  • ADMIN: The administrator.
  • RESELLER: The reseller.

This parameter is visible only to the super administrator.
status String The status of the account.
firstName String The first name of the user.
lastName String The last name of the user.
email String The email address of the account, which is used as the login username.
company String The company name.
phone String The phone number.
address String The address.
profileImage String The URL of the avatar.
owner String The email of the owner account. This parameter is visible only to the super administrator.
ownerId Integer The ID of the owner account. This parameter is visible only to the super administrator.
twoFactorEnabled Boolean Whether two-factor authentication is enabled.
twoFactorMethod String

The verification method of two-factor authentication:

  • AUTHENTICATOR: The authenticator app (TOTP).
  • EMAIL: The email verification code.

This parameter is null when two-factor authentication is not enabled.
remark String The remark of the account.
isPrimaryAccount Boolean Whether the account is a primary account.
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).
systemLanguage String The system language.
tenantOemId Integer The default OEM ID used when creating a tenant. The value 0 indicates the standard edition. This parameter is returned only when the OEM switch is enabled.

Example

Request example

GET /uc-user/api/v1/accounts/2085315948849827842 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

Response example

HTTP/1.1 200 OK
{
  "result": {
    "id": "2085315948849827842",
    "ucId": "2085315948287791106",
    "status": "ACTIVE",
    "firstName": "Admin",
    "lastName": "Admin",
    "email": "mt1000@mailstar.top",
    "company": "",
    "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",
    "twoFactorEnabled": false,
    "isPrimaryAccount": true,
    "createTime": 1786013040167,
    "updateTime": 1792049612447,
    "systemLanguage": "en",
    "tenantOemId": 84
  },
  "requestId": "031a4e14cc41f10a9018756b5c4bc693",
  "code": "200",
  "message": "SUCCESS"
}