Method: users.update
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
更新使用者。
這個方法支援 patch 語意,也就是說您只需納入要更新的欄位。系統會保留要求中未出現的欄位,並清除設為 null
的欄位。
如果重複欄位包含陣列,陣列中的個別項目就無法逐一修補;必須在要求主體中提供這些項目,並附上所有項目的所需值。詳情請參閱使用者帳戶指南。
HTTP 要求
PUT https://admin.googleapis.com/admin/directory/v1/users/{userKey}
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 |
userKey |
string
在 API 要求中識別使用者。這個值可以是使用者的主要電子郵件地址、別名電子郵件地址或專屬的使用者 ID。
|
回應主體
如果成功,回應主體會包含 User
的執行例項。
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/admin.directory.user
詳情請參閱授權指南。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-25 (世界標準時間)。
[null,null,["上次更新時間:2025-07-25 (世界標準時間)。"],[],[],null,["# Method: users.update\n\nUpdates a user.\n\nThis method supports patch semantics, meaning that you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to `null` will be cleared.\n\nFor repeating fields that contain arrays, individual items in the array can't be patched piecemeal; they must be supplied in the request body with the desired values for all items. See the [user accounts guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#update_user) for more information.\n\n### HTTP request\n\n`PUT https://admin.googleapis.com/admin/directory/v1/users/{userKey}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------|---------------------------------------------------------------------------------------------------------------------------------------------|\n| `userKey` | `string` Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. |\n\n### Request body\n\nThe request body contains an instance of [User](/workspace/admin/directory/reference/rest/v1/users#User).\n\n### Response body\n\nIf successful, the response body contains an instance of [User](/workspace/admin/directory/reference/rest/v1/users#User).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/admin.directory.user`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]