TestIdentityProvider - AWS Transfer Family
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerBeispieleWeitere Informationen finden Sie unter:

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.

TestIdentityProvider

Wenn der IdentityProviderType eines für das File Transfer Protocol aktivierten Servers AWS_DIRECTORY_SERVICE oder ist, wird getestetAPI_Gateway, ob Ihr Identitätsanbieter erfolgreich eingerichtet wurde. Es wird dringend empfohlen, dass Sie diesen Vorgang aufrufen, um Ihre Authentifizierungsmethode zu testen, sobald Sie Ihren Server erstellt haben. Auf diese Weise können Sie Probleme mit der Integration des Identitätsanbieters beheben, um sicherzustellen, dass Ihre Benutzer den Dienst erfolgreich nutzen können.

Die Parameter ServerId und UserName müssen angegeben werden. Die ServerProtocolSourceIp, und UserPassword sind alle optional.

Beachten Sie Folgendes:

  • Sie können nicht verwendenTestIdentityProvider, wenn IdentityProviderType der Ihres Servers istSERVICE_MANAGED.

  • TestIdentityProviderfunktioniert nicht mit Schlüsseln: Es akzeptiert nur Passwörter.

  • TestIdentityProviderkann den Passwortvorgang für einen benutzerdefinierten Identity Provider testen, der Schlüssel und Passwörter verarbeitet.

  • Wenn Sie falsche Werte für Parameter angeben, ist das Response Feld leer.

  • Wenn Sie eine Server-ID für einen Server angeben, der vom Dienst verwaltete Benutzer verwendet, wird eine Fehlermeldung angezeigt:

    An error occurred (InvalidRequestException) when calling the TestIdentityProvider operation: s-server-ID not configured for external auth

  • Wenn Sie eine Server-ID für den --server-id Parameter eingeben, die keinen tatsächlichen Transferserver identifiziert, wird die folgende Fehlermeldung angezeigt:

    An error occurred (ResourceNotFoundException) when calling the TestIdentityProvider operation: Unknown server.

    Es ist möglich, dass sich Ihr Server in einer anderen Region befindet. Sie können eine Region angeben, indem Sie Folgendes hinzufügen:--region region-code, --region us-east-2 um beispielsweise einen Server in USA Ost (Ohio) anzugeben.

Anforderungssyntax

{
   "ServerId": "string",
   "ServerProtocol": "string",
   "SourceIp": "string",
   "UserName": "string",
   "UserPassword": "string"
}

Anforderungsparameter

Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter Allgemeine Parameter.

Die Anfrage akzeptiert die folgenden Daten im JSON Format.

ServerId

Ein vom System zugewiesener Bezeichner für einen bestimmten Server. Die Benutzerauthentifizierungsmethode dieses Servers wird mit einem Benutzernamen und einem Passwort getestet.

Typ: Zeichenfolge

Längenbeschränkungen: Feste Länge von 19.

Pattern: s-([0-9a-f]{17})

Erforderlich: Ja

ServerProtocol

Der Typ des zu testenden Dateiübertragungsprotokolls.

Die verfügbaren Protokolle sind:

  • Secure Shell (SSH) Dateiübertragungsprotokoll (SFTP)

  • Sicheres Dateiübertragungsprotokoll (FTPS)

  • Dateiübertragungsprotokoll (FTP)

  • Erklärung zur Anwendbarkeit (2) AS2

Typ: Zeichenfolge

Zulässige Werte: SFTP | FTP | FTPS | AS2

Erforderlich: Nein

SourceIp

Die Quell-IP-Adresse des zu testenden Kontos.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 32 Zeichen.

Pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

Erforderlich: Nein

UserName

Der Name des Kontos, das getestet werden soll.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 3. Maximale Länge beträgt 100 Zeichen.

Pattern: [\w][\w@.-]{2,99}

Erforderlich: Ja

UserPassword

Das Passwort des Kontos, das getestet werden soll.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 1024 Zeichen.

Erforderlich: Nein

Antwortsyntax

{
   "Message": "string",
   "Response": "string",
   "StatusCode": number,
   "Url": "string"
}

Antwortelemente

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

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

Message

Eine Meldung, die angibt, ob der Test erfolgreich war oder nicht.

Anmerkung

Wenn eine leere Zeichenfolge zurückgegeben wird, ist die wahrscheinlichste Ursache, dass die Authentifizierung aufgrund eines falschen Benutzernamens oder Passworts fehlgeschlagen ist.

Typ: Zeichenfolge

Response

Die Antwort, die von Ihrem API Gateway oder Ihrer Lambda-Funktion zurückgegeben wird.

Typ: Zeichenfolge

StatusCode

Der HTTP Statuscode, der die Antwort von Ihrem API Gateway oder Ihrer Lambda-Funktion ist.

Typ: Ganzzahl

Url

Der Endpunkt des Dienstes, der zur Authentifizierung eines Benutzers verwendet wird.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 255 Zeichen.

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

InternalServiceError

Diese Ausnahme wird ausgelöst, wenn im AWS Transfer Family Dienst ein Fehler auftritt.

HTTPStatuscode: 500

InvalidRequestException

Diese Ausnahme wird ausgelöst, wenn der Client eine falsch formatierte Anfrage sendet.

HTTPStatuscode: 400

ResourceNotFoundException

Diese Ausnahme wird ausgelöst, wenn eine Ressource vom AWS Transfer Family Family-Dienst nicht gefunden wird.

HTTPStatuscode: 400

ServiceUnavailableException

Die Anfrage ist fehlgeschlagen, da der AWS Transfer Family Family-Dienst nicht verfügbar ist.

HTTPStatuscode: 500

Beispiele

Beispiel

Die folgende Anfrage gibt eine Nachricht von einem Identitätsanbieter zurück, dass eine Kombination aus Benutzername und Passwort eine gültige Identität darstellt, mit der die Identität verwendet werden kann AWS Transfer Family.

Beispielanforderung

{
   "ServerID": "s-01234567890abcdef",
   "UserName": "my_user",
   "UserPassword": "MyPassword-1"
}

Beispiel

Die folgende Antwort zeigt eine Beispielantwort für einen erfolgreichen Test.

Beispielantwort


      
      "Response":"
      {\"homeDirectory\":\"/mybucket001\",\"homeDirectoryDetails\":null,\"homeDirectoryType\":\"PATH\",\"posixProfile\":null,
      \"publicKeys\":\"[ssh-rsa-key]\",\"role\":\"arn:aws:iam::123456789012:role/my_role\",\"policy\":null,\"username\":\"transferuser002\",
      \"identityProviderType\":null,\"userConfigMessage\":null)"}     
      "StatusCode": "200",
      "Message": ""

Beispiel

Die folgende Antwort gibt an, dass der angegebene Benutzer zu mehr als einer Gruppe gehört, die Zugriff hat.


          "Response":"",
          "StatusCode":200,
          "Message":"More than one associated access found for user's groups."

Beispiel

Wenn Sie mithilfe eines API Gateways einen benutzerdefinierten Identitätsanbieter erstellt und konfiguriert haben, können Sie den folgenden Befehl eingeben, um Ihren Benutzer zu testen:

aws transfer test-identity-provider --server-id s-0123456789abcdefg --user-name myuser

wobei s-0123456789abcdefg Ihr Transferserver und myuser der Benutzername für Ihren benutzerdefinierten Benutzer ist.

Wenn der Befehl erfolgreich ist, ähnelt Ihre Antwort der folgenden, wobei:

  • AWS-Konto Die ID ist 012345678901

  • Die Benutzerrolle ist user-role-api-gateway

  • Das Home-Verzeichnis ist myuser-bucket

  • Der öffentliche Schlüssel ist der öffentliche Schlüssel

  • Aufruf ist Aufruf URL - URL 

{
    "Response": "{\"Role\": \"arn:aws:iam::012345678901:role/user-role-api-gateway\",\"HomeDirectory\": \"/myuser-bucket\",\"PublicKeys\": \"[public-key]\"}",
    "StatusCode": 200,
    "Message": "",
    "Url": "https://invocation-URL/servers/s-0123456789abcdefg/users/myuser/config"
}

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung API in einer der sprachspezifischen Sprachen finden Sie im Folgenden AWS SDKs: