查詢單一後台使用者

View as Markdown

依 id 查詢單一後台使用者。若該 id 不存在,或屬於其他租戶,一律回傳 404 not_found,兩種情況無法從回應內容區分。

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 排查步驟,請參閱「驗證與簽章」。

Path parameters

idlongRequired

要查詢的後台使用者序號。不存在或屬於其他租戶時,一律回傳 404 not_found。

Response

OK
idlongOptional

使用者序號。

accountstring or nullOptional

帳號。

namestring or nullOptional

姓名。

emailstring or nullOptional

電子郵件。

roleIdlong or nullOptional

目前指派的角色序號。清單與單筆查詢回傳的都是實際的角色序號,不會是 null——沒有角色指派的使用者不會出現在查詢結果中。

roleNamestring or nullOptional

目前指派的角色名稱,與 roleId 對應。

statusstring or nullOptional

帳號狀態,Active(生效)或 Inactive(停用)。

outerSysCodestring or nullOptional

ERP 端的使用者代碼。

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error