UpdateUser - Amazon QuickSight
Sintaxis de la solicitudParámetros de solicitud del URICuerpo de la solicitudSintaxis de la respuestaElementos de respuestaErroresVéase también

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 Amazon QuickSight usuario.

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 del URI

La solicitud utiliza los siguientes parámetros URI.

AwsAccountId

El ID deAWScuenta en la que se encuentra el usuario. En la actualidad, utilizas el ID para elAWScuenta que contiene tu Amazon QuickSight account.

Limitaciones de longitud longitud fija de 12 caracteres.

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

Obligatorio Sí

Namespace

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

Limitaciones de longitud La longitud máxima es 64.

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

Obligatorio Sí

UserName

La Amazon QuickSight nombre de usuario que desea actualizar.

Limitaciones 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.

Type: Cadena

Obligatorio Sí

Role

La Amazon QuickSight función del usuario. La función puede ser una de las siguientes cohortes de seguridad por defecto:

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

  • AUTHOR: un usuario que puede crear orígenes de datos, conjuntos de datos, análisis y paneles.

  • ADMIN: un usuario que es autor y que también puede gestionar Amazon QuickSightConfiguración del .

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

Type: Cadena

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

Obligatorio Sí

CustomFederationProviderUrl

La URL del proveedor de OpenID Connect (OIDC) personalizado que proporciona identidad para permitir que un usuario se federe en Amazon QuickSight con unAWS Identity and Access Management(IAM) de Este parámetro solo se debe usar cuandoExternalLoginFederationProviderTypeel parámetro se establece enCUSTOM_OIDC.

Type: Cadena

Obligatorio No

CustomPermissionsName

(Solo en la 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 fuentes de datos

  • Crear y actualizar conjuntos de datos

  • Crear y actualizar informes por correo electrónico

  • Suscribirse a informes por correo

Un conjunto de permisos personalizados incluye cualquier combinación de estas restricciones. Actualmente, debe crear los nombres de perfil para los conjuntos de permisos personalizados mediante Amazon QuickSightconsola de . A continuación, se utiliza elRegisterUserOperación de API para asignar el conjunto de permisos con nombre a un Amazon QuickSight usuario.

Amazon QuickSight Los permisos personalizados se aplican a través de políticas de IAM. Por lo tanto, anulan los permisos que normalmente se conceden mediante la asignación de Amazon QuickSight usuarios a una de las cohortes de seguridad predeterminadas de Amazon QuickSight (administrador, autor, lector).

Esta característica solo está disponible para Amazon QuickSight Suscripciones a Enterprise Edition.

Type: Cadena

Limitaciones 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 compatible que proporciona identidad para permitir que un usuario se federe en Amazon QuickSight con unAWS Identity and Access Management(IAM) de El tipo de proveedor de inicio de sesión externo que se admite puede ser uno de los siguientes.

  • COGNITOAmazon Cognito obligatorio La URL del proveedor es cognito-identity.amazonaws.com. Al elegir elCOGNITOtipo de proveedor, no utilice el»CustomFederationProviderUrl«que solo se necesita cuando el proveedor externo es personalizado.

  • CUSTOM_OIDCOpenID obligatorio Al elegirCUSTOM_OIDCescriba, utilice elCustomFederationProviderUrlpara proporcionar la URL del proveedor de OIDC personalizada.

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

Type: Cadena

Obligatorio No

ExternalLoginId

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

Type: Cadena

Obligatorio No

UnapplyCustomPermissions

Una marca que se utiliza para indicar que desea eliminar 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 que se aplicara un perfil de permisos personalizado. El valor predeterminado de este parámetro es NULL y no acepta ningún otro valor.

Type: 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.

Status

El estado HTTP de la solicitud.

El servicio devuelve los datos siguientes en formato JSON.

RequestId

LaAWSID de solicitud de esta operación.

Type: Cadena

User

La Amazon QuickSight usuario.

Tipo: objeto User

Errores

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

AccessDeniedException

No tiene acceso a este artículo. Las credenciales proporcionadas no se pudieron validar. Es posible que no tenga autorización para realizar la solicitud. Asegúrese de que su cuenta esté autorizada para usar 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 encontraron 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: