Skip to navigation

查詢單一客戶帳號

View as Markdown

依 id 查詢客戶底下的單一帳號。客戶不存在或屬於其他租戶時回傳 404 company_not_found;帳號不存在、屬於其他租戶,或屬於另一家客戶時,一律回傳 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 company_not_found。

userIdlongRequired

要查詢的客戶帳號序號。不存在、屬於其他租戶,或不屬於網址上的客戶時,一律回傳 404 not_found。

Response

OK
idlongOptional

客戶帳號序號。

companyIdlongOptional

所屬客戶的序號,永遠等於網址上的 {id}。

accountstring or nullOptional

登入帳號。

namestring or nullOptional

姓名。

emailstring or nullOptional

電子郵件,未填時為空字串。

phonestring or nullOptional

手機號碼,未填時為空字串。

roleIdlongOptional

目前指派的角色序號,對應 GET /v1/company-user-roles 的 id。沒有角色指派的帳號不會出現在查詢結果中。

roleNamestring or nullOptional

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

roleTypestring or nullOptional

目前角色的類型:Boss、Employee,或租戶自訂角色的 Custom 開頭代碼。

statusstring or nullOptional

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

inviteCodestring or nullOptional

這個帳號的邀請碼,沒有邀請碼時為空字串。

firstLoginDatetimedatetime or nullOptional

首次登入時間(UTC)。null 表示還沒完成前台的首次登入流程;若貴租戶要求首次登入變更密碼,他第一次登入時會被要求改密碼。

Errors

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