本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # 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用户所在的帐户。目前，您将 ID 用于AWS包含您的Amazon QuickSight account. 长度限制：固定长度为 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`：身份由亚马逊内部拥有和管理的用户 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 策略应用。因此，它们会覆盖通常通过分配亚马逊授予的权限 QuickSight 用户加入亚马逊的默认安全群组之一 QuickSight （管理员、作者、读者）。此功能仅适用于 Amazon 可用 QuickSight 企业版订阅。类型: 字符串长度限制：最小长度为 1。最大长度为 64。模式：`^[a-zA-Z0-9+=,.@_-]+$` 必需: 否 ** [ExternalLoginFederationProviderType](#API_RegisterUser_RequestSyntax) ** 受支持的外部登录提供商的类型，它提供身份以允许用户联合到 Amazon QuickSight 关联到AWS Identity and Access Management(IAM) 角色。支持的外部登录提供程序类型可以是以下类型之一。 + `COGNITO`：Amazon Cognito。提供商的网址是 cognito-identity.amazonaws.com。在选择`COGNITO`提供商类型，请不要使用”CustomFederationProviderUrl“参数，只有在外部提供程序是自定义时才需要的。 + `CUSTOM_OIDC`：OOpenID ic) 提供商。选择时`CUSTOM_OIDC`键入，使用`CustomFederationProviderUrl`参数提供自定义的 Opc 提供商 URL。类型: 字符串必需: 否 ** [ExternalLoginId](#API_RegisterUser_RequestSyntax) ** 外部登录提供程序中用户的身份 ID。类型: 字符串必需: 否 ** [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 服务，您的策略具有正确的权限，并且您使用的是正确的访问密钥。状态代码：401 ** InternalFailureException ** 出现内部故障。状态代码：500 ** InvalidParameterValueException ** 一个或多个参数的值无效。状态代码：400 ** LimitExceededException ** 超出限制。状态代码：409 ** PreconditionNotMetException ** 未满足一个或多个先决条件。状态代码：400 ** ResourceExistsException ** 已存在指定的资源已存在。状态代码：409 ** ResourceNotFoundException ** 无法找到一个或多个资源。状态代码：404 ** ResourceUnavailableException ** 此资源当前不可用。状态代码：503 ** ThrottlingException ** 访问受限。状态代码：429 ## 另请参阅有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/RegisterUser) + [适用于 .NET 的 AWS SDK](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 SDK](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/RegisterUser) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/RegisterUser) + [AWS适用于的开发工具包 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 V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/RegisterUser)