本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # RegisterUser 建立 Amazon QuickSight 使用者，其識別與AWS Identity and Access Management(IAM) 請求中指定的身分或角色。 ## 請求語法 ``` POST /accounts/AwsAccountId/namespaces/Namespace/users HTTP/1.1 Content-type: application/json { "CustomFederationProviderUrl": "string", "CustomPermissionsName": "string", "Email": "string", "ExternalLoginFederationProviderType": "string", "ExternalLoginId": "string", "IamArn": "string", "IdentityType": "string", "SessionName": "string", "UserName": "string", "UserRole": "string" } ``` ## URI 請求參數請求會使用下列 URI 參數。 ** [AwsAccountId](#API_RegisterUser_RequestSyntax) ** 的 IDAWS使用者所在的帳戶。目前，您使用的 IDAWS您 Amazon QuickSight 帳戶。長度限制：長度為 12。模式：`^[0-9]{12}$` 必要：是 ** [Namespace](#API_RegisterUser_RequestSyntax) ** 命名空間。目前，您應該將此設為`default`。長度限制：長度上限為 64。模式：`^[a-zA-Z0-9._-]*$` 必要：是 ## 請求主體請求接受採用 JSON 格式的下列資料。 ** [Email](#API_RegisterUser_RequestSyntax) ** 您想要註冊之使用者的電子郵件地址。類型：字串必要：是 ** [IdentityType](#API_RegisterUser_RequestSyntax) ** 亞馬遜 QuickSight 支援多種管理使用者身分的方式。此參數接受兩個值： + `IAM`：身分對應至現有 IAM 使用者或角色的使用者。 + `QUICKSIGHT`：其身分由 Amazon 內部擁有和管理的使用者 QuickSight。類型：字串有效值：` IAM | QUICKSIGHT` 必要：是 ** [UserRole](#API_RegisterUser_RequestSyntax) ** amazon QuickSight 使用者的角色。使用者角色可為下列其中之一： + `READER`：只有儀表板唯讀存取權的使用者。 + `AUTHOR`：可以建立資料來源、資料集、分析和儀表板的使用者。 + `ADMIN`: 作者的使用者，也可以管理亞馬遜 QuickSight設定。 + `RESTRICTED_READER`：此角色目前無法使用。 + `RESTRICTED_AUTHOR`：此角色目前無法使用。類型：字串有效值：` ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER` 必要：是 ** [CustomFederationProviderUrl](#API_RegisterUser_RequestSyntax) ** 自定義 OpenID Connect（OIDC）提供商的 URL，該提供程序提供了可讓用戶聯合到亞馬遜的身份 QuickSight 關聯AWS Identity and Access Management(IAM) 角色。此參數只應用於`ExternalLoginFederationProviderType`參數設為`CUSTOM_OIDC`。類型：字串必要：否 ** [CustomPermissionsName](#API_RegisterUser_RequestSyntax) ** (僅限企業版) 您要指派給此使用者的自訂權限設定檔名稱。自訂權限可讓您透過限制存取下列作業來控制使用者的存取權： + 建立和更新資料來源 + 建立和更新資料集 + 建立並更新電子郵件報告 + 訂閱電子郵件報告若要將自訂權限新增至現有使用者，請使用` [UpdateUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html) `反之。一組自訂權限包括這些限制的任意組合。目前，您需要使用 Amazon 為自訂權限集建立設定檔名稱 QuickSight主控台。然後，您可以使用`RegisterUser`API 操作將指定的許可集分配給亞馬遜 QuickSight 使用者。亞馬遜 QuickSight 自訂許可可透過 IAM 政策套用。因此，它們會覆蓋通常通過分配 Amazon 授予的許可 QuickSight 亞馬遜的默認安全群組之一的用戶 QuickSight （管理員，作者，讀者）。這項功能只在 Amazon 可供使用 QuickSight Enterprise Edition。類型：字串長度限制：長度下限為 1。長度上限為 64。模式：`^[a-zA-Z0-9+=,.@_-]+$` 必要：否 ** [ExternalLoginFederationProviderType](#API_RegisterUser_RequestSyntax) ** 支援的外部登入提供者類型，可提供身分以讓使用者聯合到 Amazon QuickSight 關聯AWS Identity and Access Management(IAM) 角色。支援的外部登入提供者類型可以是下列其中一種。 + `COGNITO`：Amazon Cognito。提供者網址是具有識別身份的網址。當選擇`COGNITO`提供者類型，請勿使用」CustomFederationProviderUrl「參數只有在外部提供程序是自定義的時候才需要的。 + `CUSTOM_OIDC`：自訂 OpenID (OIDC) 提供商。當選擇`CUSTOM_OIDC`輸入，使用`CustomFederationProviderUrl`參數，提供自訂 OIDC 提供商 URL。類型：字串必要：否 ** [ExternalLoginId](#API_RegisterUser_RequestSyntax) ** 外部登入提供者中使用者的身分識別碼。類型：字串必要：否 ** [IamArn](#API_RegisterUser_RequestSyntax) ** 您正在向亞馬遜註冊的 IAM 使用者或角色 ARN QuickSight。類型：字串必要：否 ** [SessionName](#API_RegisterUser_RequestSyntax) ** 只有當您使用假設 IAM 角色註冊一或多個使用者時，才需要使用此參數。您不需要為其他案例提供工作階段名稱，例如在註冊 IAM 使用者或 Amazon 時 QuickSight 使用者。如果每個使用者都有不同的工作階段名稱，您可以使用相同的 IAM 角色註冊多個使用者。如需假設 IAM 角色的詳細資訊，請參閱[https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html](https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html)中的* AWS CLI參考。* 類型：字串長度限制：長度下限為 2。長度上限為 64。模式：`[\w+=.@-]*` 必要：否 ** [UserName](#API_RegisterUser_RequestSyntax) ** amazon QuickSight 您希望為您註冊的使用者建立的使用者名稱。類型：字串長度限制：長度下限為 1。模式：`[\u0020-\u00FF]+` 必要：否 ## 回應語法 ``` 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" }, "UserInvitationUrl": "string" } ``` ## 回應元素如果動作成功，則服務傳回下列 HTTP 回應。 ** [Status](#API_RegisterUser_ResponseSyntax) ** 請求的 HTTP 狀態。服務會傳回下列 JSON 格式的資料。 ** [RequestId](#API_RegisterUser_ResponseSyntax) ** 所以此AWS此操作的請求 ID。類型：字串 ** [User](#API_RegisterUser_ResponseSyntax) ** 使用者的使用者名稱。類型：[User](API_User.md) 物件 ** [UserInvitationUrl](#API_RegisterUser_ResponseSyntax) ** 用戶訪問完成註冊並提供密碼的 URL。僅針對識別類型為的使用者傳回此選項`QUICKSIGHT`。類型：字串 ## 錯誤如需所有動作常見的錯誤相關資訊，請參閱[常見錯誤](CommonErrors.md)。 ** AccessDeniedException ** 您無法存取此項目。提供的登入資料無法驗證。您可能無法取得授權以執行請求。確保您的帳戶已獲授權使用亞馬遜 QuickSight 服務，您的政策有正確許可，以及您使用正確的存取金鑰。 HTTP 狀態碼：401 ** InternalFailureException ** 發生內部故障。 HTTP 狀態碼：500 ** InvalidParameterValueException ** 一或多個參數的值無效。 HTTP 狀態碼：400 ** LimitExceededException ** 已超過上限。 HTTP 狀態碼：409 ** PreconditionNotMetException ** 未滿足一個或多個先決條件。 HTTP 狀態碼：400 ** ResourceExistsException ** 指定的資源已存在。 HTTP 狀態碼：409 ** ResourceNotFoundException ** 無法找到一個或多個資源。 HTTP 狀態碼：404 ** ResourceUnavailableException ** 此資源目前無法使用。 HTTP 狀態碼：503 ** ThrottlingException ** 存取已調節。 HTTP 狀態碼：429 ## 另請參閱如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明： + [AWS 命令列界面](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/RegisterUser) + [適用於 .NET 的 AWS 開發套件](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/RegisterUser) + [適用於 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/RegisterUser) + [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/RegisterUser) + [適用於 Java 的 AWS 開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/RegisterUser) + [AWS適用於的 SDK JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/RegisterUser) + [適用於 PHP V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/RegisterUser) + [適用於 Python 的 AWS SDK](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/RegisterUser) + [適用於 Ruby 的 AWS 開發套件第 3 版](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/RegisterUser)