UpdateUser - Amazon QuickSight
请求语法URI 请求参数请求正文响应语法响应元素错误另请参阅

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

UpdateUser

Amazon 的更新是 QuickSight 用户。

请求语法

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 请求参数

请求使用以下 URI 参数。

AwsAccountId

对于是的的的的的 ID。AWS用户所在的帐户。目前，您将 ID 用于AWS包含您的Amazon 的账户 QuickSight account.

长度限制：固定长度为 12。

模式：^[0-9]{12}$

必需的 是

Namespace

命名空间。目前，您应该将其设置为。default.

长度限制：最大长度为 64。

模式：^[a-zA-Z0-9._-]*$

必需的 是

UserName

Amazon QuickSight 您要更新的用户名。

长度限制：最小长度为 1。

模式：[\u0020-\u00FF]+

必需的 是

请求正文

请求接受采用 JSON 格式的以下数据。

Email

您要更新用户的电子邮件地址。

类型: 字符串

必需的 是

Role

Amazon QuickSight 用户的角色。角色可以是以下项之一：

  • READER：对控制面板具有只读访问权限。

  • AUTHOR：数据源、数据集：分析和控制面板。

  • ADMIN：作为作者的用户，也可以管理亚马逊 QuickSight设置。

Amazon 的名称 QuickSight 除了处理权限的控制台屏幕外，角色对用户不可见。

类型: 字符串

有效值: ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER

必需的 是

CustomFederationProviderUrl

自定义 OpenID Connect (OIDC) 提供商的 URL，该提供商提供身份以允许用户联合到亚马逊 QuickSight 关联对象对象AWS Identity and Access Management(IAM) 角色。只有在以下情况下才应使用此参数ExternalLoginFederationProviderType参数设置为的参数。CUSTOM_OIDC.

类型: 字符串

必需的 否

CustomPermissionsName

（仅限企业版）要分配给此用户的自定义权限配置文件的名称。自定义权限允许您通过限制以下操作的访问权限来控制用户的访问权限：

  • 创建和更新数据源

  • 创建和更新数据集

  • 创建和更新电子邮件报告。

  • 订阅电子邮件报告。

一组自定义权限包括这些限制的任意组合。目前，您需要使用 Amazon 为自定义权限集创建配置文件名称 QuickSight控制台。然后，使用的是的是的RegisterUser为亚马逊分配指定权限集的 API 操作 QuickSight 用户。

亚马逊 QuickSight 自定义权限是通过 IAM 策略应用的。因此，它们会覆盖通常通过分配亚马逊授予的权限 QuickSight 用户加入亚马逊的默认安全群组之一 QuickSight （管理员、作者、读者）。

此功能仅适用于 Amazon。 QuickSight 企业版订阅。

类型: 字符串

长度限制：最小长度为 1。最大长度为 64。

模式：^[a-zA-Z0-9+=,.@_-]+$

必需的 否

ExternalLoginFederationProviderType

受支持的外部登录提供商的类型，它提供身份以允许用户联合到 Amazon QuickSight 关联对象对象AWS Identity and Access Management(IAM) 角色。支持的外部登录提供商的类型可以是以下项之一。

  • COGNITO：2Amazon Cognito。提供商的网址是 cognito-identity.amazonaws.com。在选择COGNITO提供商类型，请不要使用”CustomFederationProviderUrl“参数，只有在外部提供程序是自定义时才需要的。

  • CUSTOM_OIDC：OpenID Connect (OIDC) 提供商。选择时CUSTOM_OIDC键入，使用CustomFederationProviderUrl参数来提供自定义 OIDC 提供商 URL。

  • NONE：这将清除用户以前保存的所有外部登录信息。使用 DescribeUser 用于检查外部登录信息的 API 操作。

类型: 字符串

必需的 否

ExternalLoginId

外部登录提供程序中用户的身份 ID。

类型: 字符串

必需的 否

UnapplyCustomPermissions

用于指示要删除此用户的所有自定义权限的标志。使用此参数可将用户重置为应用自定义权限配置文件之前的状态。此参数默认为 NULL，并且不接受任何其他值。

类型: 布尔值

必需的 否

响应语法

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"
   }
}

响应元素

如果此操作成功，则该服务将会发送回 HTTP 响应。

Status

请求的 HTTP 状态。

服务以 JSON 格式返回的以下数据。

RequestId

这些区域有：AWS此操作的请求 ID。

类型: 字符串

User

Amazon QuickSight 用户。

类型：User 对象

错误

有关所有操作共有的错误的信息，请参阅常见错误.

AccessDeniedException

您无权访问该项目。无法验证提供的凭证。您可能无权执行请求。确保您的账户已获得使用亚马逊的授权 QuickSight 服务，您的权限，您使用的是正确的访问密钥。

HTTP 状态代码：401

InternalFailureException

出现内部故障。

HTTP 状态代码：500

InvalidParameterValueException

一个或多个参数的值无效。

HTTP 状态代码：400

PreconditionNotMetException

未满足一个或多个先决条件。

HTTP 状态代码：400

ResourceNotFoundException

无法找到一个或多个资源。

HTTP 状态代码：404

ResourceUnavailableException

此资源当前不可用。

HTTP 状态代码：503

ThrottlingException

访问受限。

HTTP 状态代码：429

另请参阅

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：