

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# UpdateUser
<a name="API_UpdateUser"></a>

Met à jour Amazon QuickSight utilisateur.

## Syntaxe de la demande
<a name="API_UpdateUser_RequestSyntax"></a>

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

## Paramètres de demande URI
<a name="API_UpdateUser_RequestParameters"></a>

La demande utilise les paramètres URI suivants.

 ** [AwsAccountId](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-AwsAccountId"></a>
ID pour le pluginAWScompte dans lequel se trouve l'utilisateur. Actuellement, vous utilisez l'ID pourAWScompte qui contient votre Amazon QuickSight .  
Contraintes de longueur : Longueur fixe de 12.  
Modèle : `^[0-9]{12}$`   
Obligatoire : Oui

 ** [Namespace](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-Namespace"></a>
Espace de noms. Pour le moment, vous devez définir cette valeur sur`default`.  
Contraintes de longueur : Longueur maximale de 64.  
Modèle : `^[a-zA-Z0-9._-]*$`   
Obligatoire : Oui

 ** [UserName](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-UserName"></a>
Amazon QuickSight Nom d'utilisateur que vous souhaitez mettre à jour.  
Contraintes de longueur : Longueur minimale de 1.  
Modèle : `[\u0020-\u00FF]+`   
Obligatoire : Oui

## Corps de la demande
<a name="API_UpdateUser_RequestBody"></a>

Cette demande accepte les données suivantes au format JSON.

 ** [Email](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-Email"></a>
Adresse e-mail de l'utilisateur que vous souhaitez mettre à jour.  
Type : Chaîne  
Obligatoire : Oui

 ** [Role](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-Role"></a>
Amazon QuickSight rôle de l'utilisateur. Le rôle peut être l'une des cohortes de sécurité par défaut suivantes :  
+  `READER`: Obligatoire en lecture seule aux tableaux de bord.
+  `AUTHOR`: Obligatoire de créer des sources de données, des ensembles de données, des analyses et des tableaux de bord.
+  `ADMIN`: un utilisateur qui est un auteur, qui peut également gérer Amazon QuickSightParamètres de .
Nom de Amazon QuickSight est invisible pour l'utilisateur, à l'exception des écrans de console traitant des autorisations.  
Type : Chaîne  
Valeurs valides :` ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER`   
Obligatoire : Oui

 ** [CustomFederationProviderUrl](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-CustomFederationProviderUrl"></a>
URL du fournisseur OpenID Connect (OIDC) personnalisé qui fournit l'identité permettant à un utilisateur de se fédérer dans Amazon QuickSight avec un associéGestion des identités et des accès AWS(IAM). Ce paramètre ne doit être utilisé que lorsque`ExternalLoginFederationProviderType`Le paramètre est défini sur`CUSTOM_OIDC`.  
Type : Chaîne  
Obligatoire : Non

 ** [CustomPermissionsName](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-CustomPermissionsName"></a>
(édition Enterprise uniquement) Nom du profil d'autorisations personnalisé que vous souhaitez attribuer à cet utilisateur. Les autorisations personnalisées vous permettent de contrôler l'accès d'un utilisateur en restreignant l'accès aux opérations suivantes :  
+ Création et mise à jour de sources de
+ Création et mise à jour de jeux de
+ Création et mise à jour des rapports envoyés
+ S'abonner aux rapports envoyés par e-mail
Un ensemble d'autorisations personnalisées inclut n'importe quelle combinaison de ces restrictions. Actuellement, vous devez créer les noms de profil pour les ensembles d'autorisations personnalisés à l'aide d'Amazon QuickSightconsole Ensuite, vous utilisez le plugin`RegisterUser`Opération d'API pour attribuer l'ensemble nommé d'autorisations à un Amazon QuickSight utilisateur.   
Amazon QuickSight Les autorisations personnalisées sont appliquées via des stratégies IAM. Par conséquent, ils remplacent les autorisations généralement accordées en attribuant Amazon QuickSight utilisateurs de l'une des cohortes de sécurité par défaut d'Amazon QuickSight (administrateur, auteur, lecteur).  
Cette fonction est disponible uniquement pour Amazon QuickSight Abonnements à Enterprise Edition.  
Type : Chaîne  
Contraintes de longueur : Longueur minimale de 1. Longueur maximale de 64.  
Modèle : `^[a-zA-Z0-9+=,.@_-]+$`   
Obligatoire : Non

 ** [ExternalLoginFederationProviderType](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-ExternalLoginFederationProviderType"></a>
Type de fournisseur de connexion externe pris en charge qui fournit une identité permettant à un utilisateur de se fédérer dans Amazon QuickSight avec un associéGestion des identités et des accès AWS(IAM). Le type de fournisseur de connexion externe pris en charge peut être l'un des périphériques suivants.  
+  `COGNITO`: Amazon Cognito. L'URL du fournisseur est cognito-identity.amazonaws.com. Lors du choix du`COGNITO`type de fournisseur, n'utilisez pas le »CustomFederationProviderUrl» qui n'est nécessaire que lorsque le fournisseur externe est personnalisé.
+  `CUSTOM_OIDC`: Obligatoire OpenID Connect (OIDC). Au moment de choisir`CUSTOM_OIDC`tapez, utilisez le`CustomFederationProviderUrl`pour fournir l'URL du fournisseur OIDC personnalisé.
+  `NONE`: Cela efface toutes les informations de connexion externes précédemment enregistrées pour un utilisateur. Utilisation de l'` [DescribeUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeUser.html) `Opération API pour vérifier les informations de connexion externes.
Type : Chaîne  
Obligatoire : Non

 ** [ExternalLoginId](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-ExternalLoginId"></a>
ID d'identité d'un utilisateur dans le fournisseur de connexion externe.  
Type : Chaîne  
Obligatoire : Non

 ** [UnapplyCustomPermissions](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-UnapplyCustomPermissions"></a>
Indicateur que vous utilisez pour indiquer que vous souhaitez supprimer toutes les autorisations personnalisées de cet utilisateur. L'utilisation de ce paramètre réinitialise l'utilisateur dans l'état dans lequel il se trouvait avant l'application d'un profil d'autorisations personnalisé. Ce paramètre est NULL par défaut et n'accepte aucune autre valeur.  
Type : Booléen  
Obligatoire : Non

## Syntaxe de la réponse
<a name="API_UpdateUser_ResponseSyntax"></a>

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

## Eléments de réponse
<a name="API_UpdateUser_ResponseElements"></a>

Si l'action aboutit, le service renvoie la réponse HTTP suivante.

 ** [Status](#API_UpdateUser_ResponseSyntax) **   <a name="QS-UpdateUser-response-Status"></a>
Le statut HTTP de la requête.

Les données suivantes sont renvoyées au format JSON par le service.

 ** [RequestId](#API_UpdateUser_ResponseSyntax) **   <a name="QS-UpdateUser-response-RequestId"></a>
LeAWSID de la demande pour cette opération.  
Type : Chaîne

 ** [User](#API_UpdateUser_ResponseSyntax) **   <a name="QS-UpdateUser-response-User"></a>
Amazon QuickSight utilisateur.  
Type : objet [User](API_User.md)

## Erreurs
<a name="API_UpdateUser_Errors"></a>

Pour plus d'informations sur les erreurs communes à toutes les actions, consultez[Erreurs courantes](CommonErrors.md).

 ** AccessDeniedException **   
Vous n'avez pas accès à cet article. Les informations d'identification fournies n'ont pas pu être validées. Il est possible que vous ne soyez pas autorisé à effectuer la demande. Assurez-vous que votre compte est autorisé à utiliser Amazon QuickSight , que vos stratégies ont les autorisations appropriées et que vous utilisez les bonnes clés d'accès.  
HTTP StaCode : 401

 ** InternalFailureException **   
Une défaillance interne s'est produite.  
HTTP StaCode : 500

 ** InvalidParameterValueException **   
La valeur d'un ou de plusieurs paramètres n'est pas valide.  
HTTP StaCode : 400

 ** PreconditionNotMetException **   
Une ou plusieurs conditions préalables ne sont pas remplies.  
HTTP StaCode : 400

 ** ResourceNotFoundException **   
Une ou plusieurs ressources sont introuvables.  
HTTP StaCode : 404

 ** ResourceUnavailableException **   
Cette ressource n'est pas disponible actuellement.  
HTTP StaCode : 503

 ** ThrottlingException **   
L'accès est limité.  
HTTP StaCode : 429

## Voir aussi
<a name="API_UpdateUser_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :
+  [Interface de ligne de commande AWS](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/UpdateUser) 
+  [AWS SDK pour .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/UpdateUser) 
+  [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/UpdateUser) 
+  [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/UpdateUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/UpdateUser) 
+  [AWSKits SDK pour JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/UpdateUser) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/UpdateUser) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/UpdateUser) 
+  [Kit SDK AWS pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/UpdateUser) 