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. # RegisterUser Crée une Amazon QuickSight utilisateur, dont l'identité est associée àGestion des identités et des accès AWS(IAM) ou le rôle spécifié dans la demande. ## Syntaxe de la demande ``` 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" } ``` ## Paramètres de demande URI La demande utilise les paramètres URI suivants. ** [AwsAccountId](#API_RegisterUser_RequestSyntax) ** ID pourAWScompte dans lequel se trouve l'utilisateur. Actuellement, vous utilisez l'ID pour leAWScompte qui contient votre Amazon QuickSight . Contraintes de longueur : Longueur fixe de 12. Modèle : `^[0-9]{12}$` Obligatoire. Oui ** [Namespace](#API_RegisterUser_RequestSyntax) ** Espace de noms. Actuellement, vous devez définir cette valeur sur`default`. Contraintes de longueur : Longueur maximale de 64. Modèle : `^[a-zA-Z0-9._-]*$` Obligatoire. Oui ## Corps de la demande Cette demande accepte les données suivantes au format JSON. ** [Email](#API_RegisterUser_RequestSyntax) ** Adresse e-mail de l'utilisateur que vous souhaitez établir un enregistrement. Type : Chaîne Obligatoire. Oui ** [IdentityType](#API_RegisterUser_RequestSyntax) ** Amazon QuickSight prend en charge plusieurs méthodes de gestion de l'identité des utilisateurs. Ce paramètre accepte deux valeurs : + `IAM`: utilisateur dont l'identité correspond à un utilisateur ou un rôle IAM existant. + `QUICKSIGHT`: utilisateur dont l'identité est détenue et gérée en interne par Amazon QuickSight. Type : Chaîne Valeurs valides :` IAM | QUICKSIGHT` Obligatoire. Oui ** [UserRole](#API_RegisterUser_RequestSyntax) ** Amazon QuickSight rôle pour l'utilisateur. Le rôle d'utilisateur peut être l'un des périphériques suivants : + `READER`: utilisateur disposant d'un accès en lecture seule aux tableaux de bord. + `AUTHOR`: utilisateur pouvant 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 . + `RESTRICTED_READER`: ce rôle n'est actuellement pas disponible. + `RESTRICTED_AUTHOR`: ce rôle n'est actuellement pas disponible. Type : Chaîne Valeurs valides :` ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER` Obligatoire. Oui ** [CustomFederationProviderUrl](#API_RegisterUser_RequestSyntax) ** 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_RegisterUser_RequestSyntax) ** (é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 Pour ajouter des autorisations personnalisées à un utilisateur existant, utilisez` [UpdateUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html) `à la place. 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_RegisterUser_RequestSyntax) ** 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 d'accès externe pris en charge peut être l'un des 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`: fournisseur OpenID Connect (OIDC) personnalisé OpenID Connect (OIDC) Lors du choix`CUSTOM_OIDC`tapez, utilisez le`CustomFederationProviderUrl`pour fournir l'URL du fournisseur OIDC personnalisée. Type : Chaîne Obligatoire. Non ** [ExternalLoginId](#API_RegisterUser_RequestSyntax) ** ID d'identité d'un utilisateur dans le fournisseur de connexion externe. Type : Chaîne Obligatoire. Non ** [IamArn](#API_RegisterUser_RequestSyntax) ** ARN de l'utilisateur IAM ou du rôle que vous enregistrez auprès d'Amazon QuickSight. Type : Chaîne Obligatoire. Non ** [SessionName](#API_RegisterUser_RequestSyntax) ** Vous devez utiliser ce paramètre uniquement lorsque vous enregistrez un ou plusieurs utilisateurs utilisant un rôle IAM assumé. Il n'est pas nécessaire de fournir le nom de la session pour d'autres scénarios, par exemple lorsque vous enregistrez un utilisateur IAM ou un compte Amazon QuickSight utilisateur. Vous pouvez enregistrer plusieurs utilisateurs utilisant le même rôle IAM si chaque utilisateur a un nom de session différent. Pour de plus amples informations sur la prise en charge des rôles IAM, consultez[https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html](https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html)dans le* AWS CLIRéférence.* Type : Chaîne Contraintes de longueur : Longueur minimale de 2. Longueur maximale de 64. Modèle : `[\w+=.@-]*` Obligatoire. Non ** [UserName](#API_RegisterUser_RequestSyntax) ** Amazon QuickSight nom d'utilisateur que vous souhaitez créer pour l'utilisateur que vous enregistrez. Type : Chaîne Contraintes de longueur : Longueur minimale de 1. Modèle : `[\u0020-\u00FF]+` Obligatoire. Non ## Syntaxe de la réponse ``` 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" } ``` ## Eléments de réponse Si l'action aboutit, le service renvoie la réponse HTTP suivante. ** [Status](#API_RegisterUser_ResponseSyntax) ** Le statut HTTP de la requête. Les données suivantes sont renvoyées au format JSON par le service. ** [RequestId](#API_RegisterUser_ResponseSyntax) ** LeAWSID de demande pour cette opération. Type : Chaîne ** [User](#API_RegisterUser_ResponseSyntax) ** Nom d'utilisateur de l'utilisateur. Type : objet [User](API_User.md) ** [UserInvitationUrl](#API_RegisterUser_ResponseSyntax) ** URL visitée par l'utilisateur pour terminer l'enregistrement et fournir un mot de passe. Ceci est renvoyé uniquement pour les utilisateurs dont le type d'identité est`QUICKSIGHT`. Type : Chaîne ## Erreurs 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 Status Status Code : 401 ** InternalFailureException ** Une défaillance interne s'est produite. HTTP Status Status Code : 500 ** InvalidParameterValueException ** Un ou plusieurs paramètres ont une valeur non valide. HTTP Status Status Code : 400 ** LimitExceededException ** Une limite est dépassée. HTTP Status Status Code : 409 ** PreconditionNotMetException ** Une ou plusieurs conditions préalables ne sont pas remplies. HTTP Status Status Code : 400 ** ResourceExistsException ** La ressource spécifiée existe déjà. HTTP Status Status Code : 409 ** ResourceNotFoundException ** Une ou plusieurs ressources sont introuvables. HTTP Status Status Code : 404 ** ResourceUnavailableException ** Cette ressource n'est pas disponible actuellement. HTTP Status Status Code : 503 ** ThrottlingException ** L'accès est limité. HTTP Status Status Code : 429 ## Voir aussi 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/RegisterUser) + [AWS SDK pour .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/RegisterUser) + [Kit AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/RegisterUser) + [Kit AWS SDK pour Go](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/RegisterUser) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/RegisterUser) + [AWSKits SDK pour JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/RegisterUser) + [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/RegisterUser) + [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/RegisterUser) + [Kit SDK AWS pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/RegisterUser)