UpdateUser -

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

UpdateUser

Actualiza un usuario de Amazon QuickSight.

Sintaxis de la solicitud

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 }

Parámetros de solicitud URI

La solicitud utiliza los siguientes parámetros URI.

AwsAccountId

El ID de la cuenta de AWS en la que se encuentra el usuario. Actualmente, utiliza el ID de la cuenta de AWS en la que se encuentra su cuenta de Amazon QuickSight.

Restricciones de longitud: Longitud fija de 12.

Patrón: ^[0-9]{12}$

: obligatorio Sí

Espacio de nombres

El espacio de nombres. Actualmente, debe establecer esto endefault.

Restricciones de longitud: La longitud máxima es 64.

Patrón: ^[a-zA-Z0-9._-]*$

: obligatorio Sí

UserName

El nombre de usuario de Amazon QuickSight que desea actualizar.

Restricciones de longitud: Longitud mínima de 1.

Patrón: [\u0020-\u00FF]+

: obligatorio Sí

Cuerpo de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

Email

La dirección de correo electrónico del usuario que desea actualizar.

Tipo: Cadena

: obligatorio Sí

Rol

Función Amazon QuickSight del usuario. El rol puede ser una de las siguientes cohortes de seguridad predeterminadas:

  • READER: un usuario que tiene acceso de solo lectura a los paneles de control.

  • AUTHORUsuario: puede crear orígenes de datos, conjuntos de datos, análisis y paneles.

  • ADMIN: usuario que es autor y que también puede gestionar la configuración de Amazon QuickSight.

El nombre de la función QuickSight es invisible para el usuario, excepto para las pantallas de la consola que se ocupan de los permisos.

Tipo: Cadena

Valores válidos: ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER

: obligatorio Sí

CustomFederationProviderURL

Dirección URL del proveedor personalizado de OpenID Connect (OIDC) que proporciona identidad para permitir a un usuario federarse en QuickSight con un rol de AWS Identity and Access Management (IAM) asociado. Este parámetro sólo se debe utilizar cuandoExternalLoginFederationProviderTypeEl parámetro se establece enCUSTOM_OIDC.

Tipo: Cadena

: obligatorio No

CustomPermissionsName

(Sólo edición Enterprise) El nombre del perfil de permisos personalizados que desea asignar a este usuario. Los permisos personalizados le permiten controlar el acceso de un usuario restringiendo el acceso a las siguientes operaciones:

  • Crear y actualizar orígenes de datos

  • Crear y actualizar conjuntos de datos

  • Crear y actualizar informes de correo electrónico

  • Suscribirse a informes por email

Un conjunto de permisos personalizados incluye cualquier combinación de estas restricciones. Actualmente, debe crear los nombres de perfil para conjuntos de permisos personalizados mediante la consola de QuickSight. A continuación, debe utilizar laRegisterUserpara asignar el conjunto de permisos con nombre asignado a un usuario de QuickSight.

Los permisos personalizados de QuickSight se aplican a través de políticas de IAM. Por lo tanto, anulan los permisos normalmente concedidos asignando usuarios de QuickSight a una de las cohortes de seguridad predeterminadas en QuickSight (admin, autor, lector).

Esta función sólo está disponible para las suscripciones de QuickSight Enterprise Edition que utilizan SAML 2.0 Based Federation for Single Sign-On (SSO).

Tipo: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es 64.

Patrón: ^[a-zA-Z0-9+=,.@_-]+$

: obligatorio No

ExternAlloginFederationProviderType

El tipo de proveedor de inicio de sesión externo admitido que proporciona identidad para permitir que un usuario se federe en QuickSight con un rol de AWS Identity and Access Management (IAM) asociado. El tipo de proveedor de inicio de sesión externo compatible puede ser uno de los siguientes.

  • COGNITO: Amazon Cognito. La URL del proveedor es cognito-identity.amazonaws.com. Al elegir elCOGNITO, no use el parámetro «CustomFederationProviderUrl», que solo es necesario cuando el proveedor externo es personalizado.

  • CUSTOM_OIDCProveedor de OpenID Connect (OIDC) personalizado. Al elegirCUSTOM_OIDC, utilice elCustomFederationProviderUrlpara proporcionar la URL del proveedor OIDC personalizada.

  • NONE: Esto borra toda la información de inicio de sesión externa guardada previamente para un usuario. Usar DescribeUser API para comprobar la información de inicio de sesión externa.

Tipo: Cadena

: obligatorio No

ExternalLoginid

El ID de identidad de un usuario en el proveedor de inicio de sesión externo.

Tipo: Cadena

: obligatorio No

DesaplicarPermisos Personalizados

Indicador que se utiliza para indicar que desea quitar todos los permisos personalizados de este usuario. El uso de este parámetro restablece al usuario al estado en el que se encontraba antes de aplicar un perfil de permisos personalizado. Este parámetro es NULL por defecto y no acepta ningún otro valor.

Tipo: Booleano

: obligatorio No

Sintaxis de la respuesta

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

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve la siguiente respuesta HTTP.

Estado

El estado HTTP de la solicitud.

El servicio devuelve los datos siguientes en formato JSON.

RequestId

ID de solicitud de AWS de esta operación.

Tipo: Cadena

Usuario

El usuario de Amazon QuickSight.

Tipo: objeto User

Errors

Para obtener información sobre errores que son comunes a todas las acciones, consulteErrores comunes.

AccessDeniedException

No tiene permiso de acceso. La credenciales proporcionadas no se pudieron validar. Es posible que no tenga autorización para realizar la solicitud. Asegúrese de que su cuenta tiene permiso para utilizar el servicio de Amazon QuickSight, que las políticas tienen los permisos correctos y que está utilizando las claves de acceso correctas.

Código de estado HTTP: 401

InternalFailureException

Se produjo un error interno.

Código de estado HTTP: 500

InvalidParameterValueException

Uno o más parámetros tienen un valor que no es válido.

Código de estado HTTP: 400

PreconditionNotMetException

No se cumplen una o varias condiciones previas.

Código de estado HTTP: 400

ResourceNotFoundException

No se encuentran uno o varios recursos.

Código de estado HTTP: 404

ResourceUnavailableException

Este recurso no está disponible en este momento.

Código de estado HTTP: 503

ThrottlingException

El acceso está limitado.

Código de estado HTTP: 429

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte: