本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# UpdateUser
<a name="API_UpdateUser"></a>

更新 Amazon QuickSight 使用者。

## 請求語法
<a name="API_UpdateUser_RequestSyntax"></a>

```
PUT /accounts/AwsAccountId/namespaces/Namespace/users/UserName HTTP/1.1
Content-type: application/json

{
   "CustomFederationProviderUrl": "string",
   "CustomPermissionsName": "string",
   "Email": "string",
   "ExternalLoginFederationProviderType": "string",
   "ExternalLoginId": "string",
   "Role": "string",
   "UnapplyCustomPermissions": boolean
}
```

## URI 請求參數
<a name="API_UpdateUser_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [AwsAccountId](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-AwsAccountId"></a>
的 IDAWS使用者所在的帳戶。目前，您使用的 IDAWSAmazon QuickSight 帳戶。  
長度限制：長度固定長度為 12。  
模式：`^[0-9]{12}$`  
必要 是

 ** [Namespace](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-Namespace"></a>
命名空間。目前，您應該將此設為`default`。  
長度限制：長度上限為 64。  
模式：`^[a-zA-Z0-9._-]*$`  
必要 是

 ** [UserName](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-UserName"></a>
Amazon QuickSight 您欲更新的使用者名稱。  
長度限制：長度下限為 1。  
模式：`[\u0020-\u00FF]+`  
必要 是

## 請求主體
<a name="API_UpdateUser_RequestBody"></a>

請求接受採用 JSON 格式的下列資料。

 ** [Email](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-Email"></a>
您欲更新的使用者的電子郵件地址。  
類型：字串  
必要 是

 ** [Role](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-Role"></a>
Amazon QuickSight 使用者的角色。角色可以是下列其中一種預設安全性群組：  
+  `READER`：具有儀表板的唯讀存取權的使用者。
+  `AUTHOR`：可以建立資料來源、資料集、分析和儀表板。
+  `ADMIN`: 作者的使用者，也可以管理亞馬遜 QuickSight設定設定設定
Amazon 的名字 QuickSight 角色對用戶是不可見的，除了處理權限的控制台屏幕。  
類型：字串  
有效值：` ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER`  
必要 是

 ** [CustomFederationProviderUrl](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-CustomFederationProviderUrl"></a>
自定義 OpenID Connect（OIDC）提供商的 URL，該提供程序提供了可讓用戶聯合到亞馬遜的身份 QuickSight 關聯至AWS Identity and Access Management(IAM) 角色。此參數只能在下列情況下使用`ExternalLoginFederationProviderType`參數設為`CUSTOM_OIDC`。  
類型：字串  
必要 否

 ** [CustomPermissionsName](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-CustomPermissionsName"></a>
(僅限企業版) 您要指派給此使用者的自訂權限設定檔名稱。自訂權限可讓您透過限制存取下列作業來控制使用者的存取：  
+ 建立和更新資料來源
+ 建立和更新資料集
+ 建立並更新電子郵件報告
+ 訂閱電子郵件報告
一組自訂權限包括這些限制的任意組合。目前，您需要使用 Amazon 為自訂權限集建立設定檔名稱 QuickSight主控台。然後，您可以使用`RegisterUser`API 操作將指定的許可集分配給亞馬遜 QuickSight 使用者。  
亞馬遜 QuickSight 自訂許可可是透過 IAM 政策套用。因此，它們會覆蓋通常通過分配 Amazon 授予的許可 QuickSight 亞馬遜的默認安全群組之一的用戶 QuickSight （管理員，作者，讀者）。  
此功能只適用於 Amazon QuickSight 企業版訂閱。  
類型：字串  
長度限制：長度下限為 1。長度上限為 64。  
模式：`^[a-zA-Z0-9+=,.@_-]+$`  
必要 否

 ** [ExternalLoginFederationProviderType](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-ExternalLoginFederationProviderType"></a>
支援的外部登入提供者類型，提供身分讓使用者聯合到 Amazon QuickSight 關聯至AWS Identity and Access Management(IAM) 角色。支援的外部登入提供商類型可以是下列其中一種。  
+  `COGNITO`：Amazon Cognito。提供者的網址是具有識別身份的. 當選擇`COGNITO`提供者類型，請勿使用」CustomFederationProviderUrl「參數只有在外部提供程序是自定義的時候才需要的。
+  `CUSTOM_OIDC`：自訂 OpenID Connect (OIDC) 供應商。當選擇`CUSTOM_OIDC`輸入，使用`CustomFederationProviderUrl`參數，以提供自訂 OIDC 提供商 URL。
+  `NONE`：這會清除使用者先前儲存的所有外部登入資訊。使用` [DescribeUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeUser.html) `檢查外部登錄信息的 API 操作。
類型：字串  
必要 否

 ** [ExternalLoginId](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-ExternalLoginId"></a>
外部登入提供者中使用者的身分識別碼。  
類型：字串  
必要 否

 ** [UnapplyCustomPermissions](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-UnapplyCustomPermissions"></a>
用來指出您要移除此使用者的所有自訂權限的旗標。使用此參數會將使用者重設為套用自訂權限設定檔之前的狀態。此參數預設為 NULL，並且不接受任何其他值。  
類型：Boolean  
必要 否

## 回應語法
<a name="API_UpdateUser_ResponseSyntax"></a>

```
HTTP/1.1 Status
Content-type: application/json

{
   "RequestId": "string",
   "User": { 
      "Active": boolean,
      "Arn": "string",
      "CustomPermissionsName": "string",
      "Email": "string",
      "ExternalLoginFederationProviderType": "string",
      "ExternalLoginFederationProviderUrl": "string",
      "ExternalLoginId": "string",
      "IdentityType": "string",
      "PrincipalId": "string",
      "Role": "string",
      "UserName": "string"
   }
}
```

## 回應元素
<a name="API_UpdateUser_ResponseElements"></a>

如果動作成功，則服務傳回下列 HTTP 回應。

 ** [Status](#API_UpdateUser_ResponseSyntax) **   <a name="QS-UpdateUser-response-Status"></a>
請求的 HTTP 狀態。

服務會傳回下列 JSON 格式的資料。

 ** [RequestId](#API_UpdateUser_ResponseSyntax) **   <a name="QS-UpdateUser-response-RequestId"></a>
所以此AWS此操作的請求 ID。  
類型：字串

 ** [User](#API_UpdateUser_ResponseSyntax) **   <a name="QS-UpdateUser-response-User"></a>
Amazon QuickSight 使用者。  
類型：[User](API_User.md) 物件

## 錯誤
<a name="API_UpdateUser_Errors"></a>

如需所有動作常見的錯誤相關資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AccessDeniedException **   
您無法存取。提供的登入資料無法驗證。您可能無法取得授權以執行請求。確保您的帳戶被授權使用亞馬遜 QuickSight 服務，您的政策具有正確的存取金鑰。  
HTTP 狀態碼：401

 ** InternalFailureException **   
發生內部故障。  
HTTP 狀態碼：500

 ** InvalidParameterValueException **   
一或多個參數的值無效。  
HTTP 狀態碼：400

 ** PreconditionNotMetException **   
未滿足一個或多個先決條件。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
無法找到一個或多個資源。  
HTTP 狀態碼：404

 ** ResourceUnavailableException **   
此資源目前無法使用。  
HTTP 狀態碼：503

 ** ThrottlingException **   
存取已調節。  
HTTP 狀態碼：429

## 另請參閱
<a name="API_UpdateUser_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS 命令列界面](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/UpdateUser) 
+  [適用於 .NET 的 AWS 開發套件](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/UpdateUser) 
+  [適用於 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/UpdateUser) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/UpdateUser) 
+  [適用於 Java 的 AWS 開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/UpdateUser) 
+  [AWS適合的開發套 JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/UpdateUser) 
+  [適用於 PHP V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/UpdateUser) 
+  [適用於 Python 的 AWS SDK](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/UpdateUser) 
+  [適用於 Ruby 的 AWS 開發套件第 3 版](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/UpdateUser)