> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.orderupb2b.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.orderupb2b.com/_mcp/server. # 更新後台使用者 PUT https://api.example.com/v1/internal-users/{id} Content-Type: application/json 依 id 更新後台使用者，部分合併——只送有異動的欄位，省略的欄位維持原值；省略 password 表示不改密碼。id 不存在或屬於其他租戶時回傳 404。status 只接受 Active 或 Inactive，其他值一律回傳 400 invalid_status；帶入 roleId 時同樣必須指向呼叫端所屬租戶的既有角色，否則回傳 400 invalid_role_id。改變 roleId，或把 status 設為 Inactive，會立即讓這個使用者既有的登入階段失效，不必等 token 自然過期。若這個使用者是租戶目前唯一還能登入的系統管理員，把他改成非管理員角色、或把狀態設為 Inactive，會讓租戶失去所有可登入的系統管理員——這支端點會拒絕該次寫入，回傳 409 last_active_admin。 Reference: https://docs.orderupb2b.com/api-reference/internal-users/update-internal-user ## Authentication - `X-Signature` header (required) — 每個 /v1 請求都必須帶 X-Client-Id、X-Timestamp、X-Nonce 與 X-Signature 四個標頭。X-Signature 是以 client secret 對 canonical string 做 HMAC-SHA256 後的 Base64。canonical string 的組成、可複製的簽章範例與 401 排查步驟，請參閱「驗證與簽章」。 ## Request ### Path parameters - `id` (long, required) — 要更新的後台使用者序號。不存在或屬於其他租戶時，一律回傳 404 not_found。 ### Body (application/json) This endpoint expects an object. - `name` (string, optional, nullable) — 姓名。省略保留現有值。長度上限 30 字元，超過回傳 400 name_too_long。 - `email` (string, optional, nullable) — 電子郵件。省略保留現有值。長度上限 100 字元，超過回傳 400 email_too_long。 - `password` (string, optional, nullable) — 登入密碼。省略表示不改密碼，這是保留原密碼的唯一方式。 - `roleId` (long, optional, nullable) — 角色序號。省略保留現有角色；帶入時必須指向呼叫端所屬租戶的既有角色，否則回傳 400 invalid_role_id。改變這個欄位會立即讓這個使用者既有的登入階段失效（詳見本端點說明）；若這個使用者是租戶目前唯一還能登入的系統管理員，把他改成非管理員角色會被拒絕，回傳 409 last_active_admin。 - `status` (string, optional, nullable) — 帳號狀態，只接受 Active 或 Inactive（大小寫不敏感），其他值回傳 400 invalid_status。省略保留現有狀態；設為 Inactive 會立即讓這個使用者既有的登入階段失效。若這個使用者是租戶目前唯一還能登入的系統管理員，設為 Inactive 會被拒絕，回傳 409 last_active_admin。 - `outerSysCode` (string, optional, nullable) — ERP 端的使用者代碼。省略保留現有值。長度上限 50 字元，超過回傳 400 outer_sys_code_too_long。 ## Response ### 200 OK - `id` (long, optional) — 新增或更新成功後，該筆資料的 id。 ## Errors ### 400 Bad Request Error Bad Request - `error` (string, optional, nullable) — 錯誤代碼，固定為 snake_case 字串，依代碼判斷失敗原因。 ### 401 Unauthorized Error Unauthorized - `error` (string, optional, nullable) — 錯誤代碼，固定為 snake_case 字串，依代碼判斷失敗原因。 ### 403 Forbidden Error Forbidden - `error` (string, optional, nullable) — 錯誤代碼，固定為 snake_case 字串，依代碼判斷失敗原因。 ### 404 Not Found Error Not Found - `error` (string, optional, nullable) — 錯誤代碼，固定為 snake_case 字串，依代碼判斷失敗原因。 ### 409 Conflict Error Conflict - `error` (string, optional, nullable) — 錯誤代碼，固定為 snake_case 字串，依代碼判斷失敗原因。 ### 500 Internal Server Error Internal Server Error - `code` (string, optional, nullable) — 錯誤代碼字串。 - `message` (string, optional, nullable) — 對應的錯誤說明文字。 ## Examples **Request** ```json {} ``` **Response** ```json { "id": 1 } ``` **SDK Code** ```python import requests url = "https://api.example.com/v1/internal-users/1" payload = {} headers = { "X-Signature": "", "Content-Type": "application/json" } response = requests.put(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.example.com/v1/internal-users/1'; const options = { method: 'PUT', headers: {'X-Signature': '', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.example.com/v1/internal-users/1" payload := strings.NewReader("{}") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("X-Signature", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.example.com/v1/internal-users/1") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request["X-Signature"] = '' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.put("https://api.example.com/v1/internal-users/1") .header("X-Signature", "") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('PUT', 'https://api.example.com/v1/internal-users/1', [ 'body' => '{}', 'headers' => [ 'Content-Type' => 'application/json', 'X-Signature' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.example.com/v1/internal-users/1"); var request = new RestRequest(Method.PUT); request.AddHeader("X-Signature", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-Signature": "", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/v1/internal-users/1")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PUT" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```