Skip to navigation

查詢後台使用者清單

View as Markdown

分頁查詢後台使用者清單。

可用下列參數篩選:

  • name、email、outerSysCode:大小寫不敏感的子字串比對
  • status:只接受 Active 或 Inactive,完全比對,但大小寫不敏感,帶 active 一樣會命中 Active——這一點與商品、規格的 status 篩選不同,那兩支要求大小寫完全相符

page 從 1 起算,pageSize 為 1–100(預設 100),超出範圍一律回 400。

Authentication

X-Signaturestring

每個 /v1 請求都必須帶 X-Client-Id、X-Timestamp、X-Nonce 與 X-Signature 四個標頭。X-Signature 是以 client secret 對 canonical string 做 HMAC-SHA256 後的 Base64。

canonical string 的組成、可複製的簽章範例與 401 排查步驟,請參閱「驗證與簽章」。

Query parameters

namestringOptional

依姓名篩選。大小寫不敏感的子字串比對,前後空白會被忽略。

emailstringOptional

依電子郵件篩選。大小寫不敏感的子字串比對,規則與 name 相同。

outerSysCodestringOptional

依 ERP 端的使用者代碼篩選。大小寫不敏感的子字串比對,前後空白會被忽略。注意這是「包含」比對,要確認某個代碼對到哪一位使用者,請核對回傳的 outerSysCode 是否完全相符;PUT /v1/internal-users/batch 的 outerSysCode 則是大小寫敏感的完全比對。

statusstringOptional

依帳號狀態篩選,只接受 Active 或 Inactive。這是完全比對,但大小寫不敏感,前後空白也會被忽略——帶 active 一樣會命中 Active。

這一點與商品、規格的 status 篩選不同,那兩支要求大小寫完全相符。

pageintegerOptional

頁碼,從 1 起算,省略時預設 1。小於 1 回傳 400 invalid_page;頁碼大到讓內部位移量溢位時同樣回傳 400 invalid_page。

pageSizeintegerOptional

每頁筆數,範圍 1 至 100,省略時預設 100。超出範圍一律回傳 400 invalid_page_size,不會自動夾限成合法值,避免分批掃描時誤判為已經抓完全部資料。

Response

OK
datalist of objects or nullOptional

本頁的後台使用者資料,每一筆為一筆後台使用者資料,形狀與「查詢單一後台使用者」的回應相同。

totalCountintegerOptional

符合篩選條件的後台使用者總數,涵蓋所有頁,不受目前頁碼影響。

currentPageintegerOptional

目前頁碼,即請求帶入的 page,從 1 起算。

pageSizeintegerOptional

目前頁面的筆數上限,即請求帶入的 pageSize。

totalPagesintegerOptional

總頁數,等於 totalCount 除以 pageSize 後無條件進位;沒有符合的資料時為 0。

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error