

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

# RegisterUser
<a name="API_RegisterUser"></a>

Erstellt ein Amazon QuickSight -Benutzer, dessen Identität derAWS Identity and Access Management(IAM) Identität oder Rolle, die in der Anfrage angegeben ist. 

## Anforderungssyntax
<a name="API_RegisterUser_RequestSyntax"></a>

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

## URI-Anfrageparameter
<a name="API_RegisterUser_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [AwsAccountId](#API_RegisterUser_RequestSyntax) **   <a name="QS-RegisterUser-request-AwsAccountId"></a>
Die -ID derAWSKonto, in dem sich der Benutzer befindet. Derzeit verwenden Sie die ID fürAWS-Konto QuickSight Konto.  
Längenbeschränkungen: Feste Länge von 12.  
Pattern: `^[0-9]{12}$`   
Required: Ja

 ** [Namespace](#API_RegisterUser_RequestSyntax) **   <a name="QS-RegisterUser-request-Namespace"></a>
Der Namespace Derzeit sollten Sie dies auf`default`.  
Längenbeschränkungen: Höchstlänge = 64 Zeichen.  
Pattern: `^[a-zA-Z0-9._-]*$`   
Required: Ja

## Anforderungstext
<a name="API_RegisterUser_RequestBody"></a>

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

 ** [Email](#API_RegisterUser_RequestSyntax) **   <a name="QS-RegisterUser-request-Email"></a>
Die E-Mail-Adresse des Benutzers, den Sie registrieren möchten.  
Type: String  
Required: Ja

 ** [IdentityType](#API_RegisterUser_RequestSyntax) **   <a name="QS-RegisterUser-request-IdentityType"></a>
Amazon QuickSight unterstützt verschiedene Methoden zur Verwaltung der Identität von Benutzern. Dieser Parameter akzeptiert zwei Werte:  
+  `IAM`: Ein Benutzer, dessen Identität einem vorhandenen IAM-Benutzer oder einer vorhandenen IAM-Rolle zugeordnet ist. 
+  `QUICKSIGHT`: Ein Benutzer, dessen Identität im Besitz von Amazon ist und intern von Amazon verwaltet wird QuickSight. 
Type: String  
Zulässige Werte:` IAM | QUICKSIGHT`   
Required: Ja

 ** [UserRole](#API_RegisterUser_RequestSyntax) **   <a name="QS-RegisterUser-request-UserRole"></a>
Der QuickSight -Rolle für den Benutzer. Die Benutzerrolle kann eine der folgenden sein:  
+  `READER`: Ein Benutzer mit schreibgeschützten Zugriff auf Dashboards.
+  `AUTHOR`: Ein Benutzer, der Datenquellen, Datasets, Analysen und Dashboards erstellen kann.
+  `ADMIN`: Ein Benutzer, der Autor ist und auch Amazon verwalten kann QuickSight-Einstellungen.
+  `RESTRICTED_READER`: Diese Rolle ist derzeit nicht verfügbar.
+  `RESTRICTED_AUTHOR`: Diese Rolle ist derzeit nicht verfügbar.
Type: String  
Zulässige Werte:` ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER`   
Required: Ja

 ** [CustomFederationProviderUrl](#API_RegisterUser_RequestSyntax) **   <a name="QS-RegisterUser-request-CustomFederationProviderUrl"></a>
Die URL des benutzerdefinierten OpenID Connect (OIDC) -Anbieters, der die Identität bereitstellt, damit ein Benutzer eine Verbindung zu Amazon herstellen kann QuickSight mitAWS Identity and Access Management(IAM) -Rolle. Dieser Parameter sollte nur verwendet werden, wenn`ExternalLoginFederationProviderType`-Parameter ist auf`CUSTOM_OIDC`.  
Type: String  
Required: Nein

 ** [CustomPermissionsName](#API_RegisterUser_RequestSyntax) **   <a name="QS-RegisterUser-request-CustomPermissionsName"></a>
(Nur Enterprise Edition) Der Name des benutzerdefinierten Berechtigungsprofils, das Sie diesem Benutzer zuweisen möchten. Mit benutzerdefinierten Berechtigungen können Sie den Zugriff eines Benutzers steuern, indem Sie den Zugriff auf die folgenden Vorgänge einschränken:  
+ Datenquellen erstellen und aktualisieren
+ Datensätze erstellen und aktualisieren
+ E-Mail-Berichte erstellen und
+ E-Mail-Berichte
Um einem vorhandenen Benutzer benutzerdefinierte Berechtigungen hinzuzufügen, verwenden Sie` [UpdateUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html) `stattdessen.  
Ein Satz benutzerdefinierter Berechtigungen umfasst eine beliebige Kombination dieser Einschränkungen. Derzeit müssen Sie die Profilnamen für benutzerdefinierte Berechtigungssätze mithilfe von Amazon erstellen QuickSightconsole. Dann verwenden Sie`RegisterUser`API-Vorgang zum Zuweisen des benannten Berechtigungssatzes zu einem Amazon QuickSight nutzer.   
Amazon QuickSight benutzerdefinierte Berechtigungen werden über IAM-Richtlinien angewendet. Daher überschreiben sie die Berechtigungen, die normalerweise durch die Zuweisung von Amazon gewährt werden QuickSight Benutzer einer der Standardsicherheitskohorten in Amazon QuickSight (Admin, Autor, Leser).  
Diese Funktion steht nur für Amazon QuickSight Abonnements der Enterprise-Edition.  
Type: String  
Längenbeschränkungen: Mindestlänge 1. Höchstlänge = 64 Zeichen.  
Pattern: `^[a-zA-Z0-9+=,.@_-]+$`   
Required: Nein

 ** [ExternalLoginFederationProviderType](#API_RegisterUser_RequestSyntax) **   <a name="QS-RegisterUser-request-ExternalLoginFederationProviderType"></a>
Der Typ des unterstützten externen Anmeldeanbieters, der die Identität bereitstellt, damit ein Benutzer eine Verbindung zu Amazon herstellen kann QuickSight mitAWS Identity and Access Management(IAM) -Rolle. Beim Typ des unterstützten externen Anmeldeanbieters kann es sich um einen der folgenden Werte handeln.  
+  `COGNITO`Amazon Cognito Die Anbieter-URL lautet cognito-identity.amazonaws.com. Bei der Auswahl des`COGNITO`Anbietertyp, verwenden Sie nicht den“CustomFederationProviderUrl„Parameter, der nur benötigt wird, wenn der externe Anbieter benutzerdefiniert ist.
+  `CUSTOM_OIDC`: Benutzerdefinierter OpenID-Connect- (OIDC) -Anbieter. Bei der Auswahl`CUSTOM_OIDC`tippe, benutze das`CustomFederationProviderUrl`-Parameter für den OIDC-Anbieter-URL.
Type: String  
Required: Nein

 ** [ExternalLoginId](#API_RegisterUser_RequestSyntax) **   <a name="QS-RegisterUser-request-ExternalLoginId"></a>
Die Identity-ID für einen Benutzer im externen Anmeldeanbieter.  
Type: String  
Required: Nein

 ** [IamArn](#API_RegisterUser_RequestSyntax) **   <a name="QS-RegisterUser-request-IamArn"></a>
Der ARN des IAM-Benutzers oder der IAM-Rolle, den Sie bei Amazon registrieren QuickSight.   
Type: String  
Required: Nein

 ** [SessionName](#API_RegisterUser_RequestSyntax) **   <a name="QS-RegisterUser-request-SessionName"></a>
Sie müssen diesen Parameter nur verwenden, wenn Sie einen oder mehrere Benutzer mit einer angenommenen IAM-Rolle registrieren. Sie müssen den Sitzungsnamen nicht für andere Szenarien angeben, z. B. wenn Sie einen IAM-Benutzer oder Amazon registrieren. QuickSight nutzer. Sie können mehrere Benutzer mit derselben IAM-Rolle registrieren, wenn jeder Benutzer einen anderen Sitzungsnamen besitzt. Weitere Informationen zur Übernahme von IAM-Rollen finden Sie unter[https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html](https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html)im* AWS CLI Reference.*   
Type: String  
Längenbeschränkungen: Mindestlänge von 2. Höchstlänge = 64 Zeichen.  
Pattern: `[\w+=.@-]*`   
Required: Nein

 ** [UserName](#API_RegisterUser_RequestSyntax) **   <a name="QS-RegisterUser-request-UserName"></a>
Der QuickSight den Sie für den Benutzer erstellen möchten, den Sie registrieren.  
Type: String  
Längenbeschränkungen: Mindestlänge 1.  
Pattern: `[\u0020-\u00FF]+`   
Required: Nein

## Antwortsyntax
<a name="API_RegisterUser_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"
   },
   "UserInvitationUrl": "string"
}
```

## Antwortelemente
<a name="API_RegisterUser_ResponseElements"></a>

Wenn die Aktion erfolgreich ist, sendet der Dienst die folgende HTTP-Antwort zurück.

 ** [Status](#API_RegisterUser_ResponseSyntax) **   <a name="QS-RegisterUser-response-Status"></a>
Der HTTP-Status der Anforderung.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

 ** [RequestId](#API_RegisterUser_ResponseSyntax) **   <a name="QS-RegisterUser-response-RequestId"></a>
DieAWS request ID for this operation.  
Type: String

 ** [User](#API_RegisterUser_ResponseSyntax) **   <a name="QS-RegisterUser-response-User"></a>
Der Benutzername des Benutzers.  
Typ: [User](API_User.md) Objekt

 ** [UserInvitationUrl](#API_RegisterUser_ResponseSyntax) **   <a name="QS-RegisterUser-response-UserInvitationUrl"></a>
Die URL, die der Benutzer besucht, um die Registrierung abzuschließen und ein Passwort anzugeben. Dies wird nur für Benutzer mit einem Identitätstyp zurückgegeben`QUICKSIGHT`.  
Type: String

## Fehler
<a name="API_RegisterUser_Errors"></a>

Hinweise zu den Fehlern, die bei allen Aktionen auftreten, finden Sie unter[Häufige Fehler](CommonErrors.md).

 ** AccessDeniedException **   
Sie haben keinen Zugriff auf diesen Artikel. Die bereitgestellten Anmeldeinformationen konnten nicht überprüft werden. Sie sind möglicherweise nicht berechtigt, die Anforderung auszuführen. Stellen Sie sicher, dass Ihr Konto für die Nutzung von Amazon autorisiert ist QuickSight -Service, dass Ihre Richtlinien die richtigen Berechtigungen besitzen und dass Sie die richtigen Zugriffsschlüssel verwenden.  
: 401

 ** InternalFailureException **   
Es ist ein interner Fehler aufgetreten.  
: 500

 ** InvalidParameterValueException **   
Ein oder mehrere Parameter haben einen Wert, der nicht gültig ist.  
: 400

 ** LimitExceededException **   
Ein Limit wurde überschritten.  
: 409

 ** PreconditionNotMetException **   
Mindestens eine Vorbedingung ist nicht erfüllt.  
: 400

 ** ResourceExistsException **   
Die angegebene Ressource ist bereits vorhanden.   
: 409

 ** ResourceNotFoundException **   
Mindestens eine Ressource kann nicht gefunden werden.  
: 404

 ** ResourceUnavailableException **   
Die Ressource ist derzeit nicht verfügbar.  
: 503

 ** ThrottlingException **   
Der Zugriff wird gedrosselt  
: 429

## Weitere Informationen finden Sie unter:
<a name="API_RegisterUser_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS-SDKs finden Sie unter:
+  [AWS-Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/RegisterUser) 
+  [AWS-SDK für .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/RegisterUser) 
+  [AWS-SDK für C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/RegisterUser) 
+  [AWS-SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/RegisterUser) 
+  [AWS-SDK für Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/RegisterUser) 
+  [AWSSDK-für JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/RegisterUser) 
+  [AWS SDK für PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/RegisterUser) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/RegisterUser) 
+  [AWS SDK für Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/RegisterUser) 