Search Tenant Owners

Request URL

POST {base_url}/uc-user/api/v1/accounts/tenant/owners/search-page

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
pageSize	No	Integer	The number of records to retrieve per page.
pageNumber	No	Integer	The page number to retrieve.
sorts	No	Array<Sort_Condition>	The sort conditions.
keyword	No	String	The keyword used for fuzzy matching.
id	No	Integer	The ID of the account, used for precise matching.
name	No	String	The name of the user, used for fuzzy matching.
email	No	String	The email address, used for fuzzy matching.

Sort_Condition


Parameter	Required	Type	Description
property	No	String	The name of the field to sort by.
direction	No	String	The sort order. Valid value: `asc`: Sort in ascending order. `desc`: Sort in descending order.

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<Tenant_Owner_Page_Result>	The search result of tenant owners.

Tenant_Owner_Page_Result


Parameter	Type	Description
pageSize	Integer	The number of records per page.
pageNumber	Integer	The current page number.
total	Integer	The total number of records that match the search conditions.
results	Array<Tenant_Owner>	The list of owners that are visible to the current user when creating a tenant.
totalPages	Integer	The total number of pages.
empty	Boolean	Whether the current page is empty.

Tenant_Owner


Parameter	Type	Description
id	String	The ID of the account.
ucId	String	The UC ID of the company.
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.
avatar	String	The URL of the avatar.
country	String	The country name synchronized from PP, which is used to match the default preference values when creating a tenant.
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.

Example

Request example

POST /uc-user/api/v1/accounts/tenant/owners/search-page 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
{
  "pageNumber": 1,
  "pageSize": 20
}

Response example

HTTP/1.1 200 OK
{
  "result": {
    "pageSize": 20,
    "pageNumber": 1,
    "total": 187,
    "results": [
      {
        "id": "2085315948849827842",
        "ucId": "2085315948287791106",
        "firstName": "Admin",
        "lastName": "Admin",
        "email": "mt1000@mailstar.top",
        "avatar": "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",
        "subType": "ADMIN"
      },
      {
        "id": "2110632027358052353",
        "ucId": "2110632027685208065",
        "firstName": "auto",
        "lastName": "test",
        "email": "autotest_17920488575546037@mailstar.top",
        "subType": "RESELLER"
      },
      {
        "id": "2110631953295032321",
        "ucId": "2110631953643159553",
        "firstName": "auto",
        "lastName": "test",
        "email": "autotest_17920488401423407@mailstar.top",
        "subType": "RESELLER"
      },
      {
        "id": "2110631903651250177",
        "ucId": "2110631903978405890",
        "firstName": "auto",
        "lastName": "test",
        "email": "autotest_17920488283613041@mailstar.top",
        "subType": "RESELLER"
      },
      {
        "id": "2110631866548436993",
        "ucId": "2110631866875592705",
        "firstName": "auto",
        "lastName": "test",
        "email": "autotest_17920488192665024@mailstar.top",
        "subType": "RESELLER"
      },
      {
        "id": "2110631769739706369",
        "ucId": "2110631770079444994",
        "firstName": "auto",
        "lastName": "test",
        "email": "autotest_17920487952811528@mailstar.top",
        "subType": "RESELLER"
      },
      {
        "id": "2110631664886300673",
        "ucId": "2110631665217650689",
        "firstName": "auto",
        "lastName": "test",
        "email": "autotest_17920487711232904@mailstar.top",
        "subType": "RESELLER"
      },
      {
        "id": "2110631413039316993",
        "ucId": "2110631413370667010",
        "firstName": "auto",
        "lastName": "test",
        "email": "autotest-r1-102923-nor-1792048717155@yeastar.com",
        "subType": "RESELLER"
      },
      {
        "id": "2110631375672262658",
        "ucId": "2110631376020389890",
        "firstName": "auto",
        "lastName": "test",
        "email": "autotest-r1-102922-noa-1792048708248@yeastar.com",
        "subType": "RESELLER"
      },
      {
        "id": "2110631347679477761",
        "ucId": "2110631348006633473",
        "firstName": "auto",
        "lastName": "test",
        "email": "autotest-r1-102921-31-1792048701577@yeastar.com",
        "subType": "RESELLER"
      },
      {
        "id": "2110631336472297474",
        "ucId": "2110631336803647489",
        "firstName": "auto",
        "lastName": "test",
        "email": "autotest-r1-102921-nop-1792048698901@yeastar.com",
        "subType": "RESELLER"
      },
      {
        "id": "2110631295925960705",
        "ucId": "2110631296332808194",
        "firstName": "auto",
        "lastName": "test",
        "email": "autotest-r1-102920-noc-1792048689238@yeastar.com",
        "subType": "RESELLER"
      },
      {
        "id": "2110083977271443457",
        "ucId": "2110083977565044738",
        "firstName": "auto",
        "lastName": "test",
        "email": "autotest-r1-103291-1791918194@yeastar.com",
        "subType": "RESELLER"
      },
      {
        "id": "2110083913220227073",
        "ucId": "2110083913518022658",
        "firstName": "auto",
        "lastName": "test",
        "email": "autotest-r1-103290@yeastar.com",
        "subType": "RESELLER"
      },
      {
        "id": "2110083367147012098",
        "ucId": "2110083367444807681",
        "firstName": "auto",
        "lastName": "test",
        "email": "autotest-r1-103288@yeastar.com",
        "subType": "RESELLER"
      },
      {
        "id": "2110082653070950402",
        "ucId": "2110082653368745985",
        "firstName": "auto",
        "lastName": "test",
        "email": "autotest-r1-103432@yeastar.com",
        "subType": "RESELLER"
      },
      {
        "id": "2110009436587294722",
        "ucId": "2110009436889284609",
        "firstName": "auto",
        "lastName": "test",
        "email": "autotest-r2-102982-1791900415033@yeastar.com",
        "subType": "RESELLER"
      },
      {
        "id": "2110009405771743234",
        "ucId": "2110009406069538818",
        "firstName": "auto",
        "lastName": "test",
        "email": "autotest-r1-102982-1791900415032@yeastar.com",
        "subType": "RESELLER"
      },
      {
        "id": "2110009158643351553",
        "ucId": "2110009158949535746",
        "firstName": "auto",
        "lastName": "test",
        "email": "autotest-r1-102976-1791900355859@yeastar.com",
        "subType": "RESELLER"
      },
      {
        "id": "2110009021544136706",
        "ucId": "2110009021846126594",
        "firstName": "auto",
        "lastName": "test",
        "email": "autotest-r1-102972-1791900323321@yeastar.com",
        "subType": "RESELLER"
      }
    ],
    "totalPages": 10,
    "empty": false
  },
  "requestId": "ab461564f456835de3fde499ddcb2fb4",
  "code": "200",
  "message": "SUCCESS"
}