TestIdentityProviderCommand

Suggest an Edit

If the IdentityProviderType of a file transfer protocol-enabled server is AWS_DIRECTORY_SERVICE or API_Gateway, tests whether your identity provider is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the identity provider integration to ensure that your users can successfully use the service.

The ServerId and UserName parameters are required. The ServerProtocol, SourceIp, and UserPassword are all optional.

Note the following:

  • You cannot use TestIdentityProvider if the IdentityProviderType of your server is SERVICE_MANAGED.

  • TestIdentityProvider does not work with keys: it only accepts passwords.

  • TestIdentityProvider can test the password operation for a custom Identity Provider that handles keys and passwords.

  • If you provide any incorrect values for any parameters, the Response field is empty.

  • If you provide a server ID for a server that uses service-managed users, you get an error:

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

  • If you enter a Server ID for the --server-id parameter that does not identify an actual Transfer server, you receive the following error:

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

    It is possible your sever is in a different region. You can specify a region by adding the following: --region region-code, such as --region us-east-2 to specify a server in US East (Ohio).

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { TransferClient, TestIdentityProviderCommand } from "@aws-sdk/client-transfer"; // ES Modules import
// const { TransferClient, TestIdentityProviderCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
const client = new TransferClient(config);
const input = { // TestIdentityProviderRequest
  ServerId: "STRING_VALUE", // required
  ServerProtocol: "SFTP" || "FTP" || "FTPS" || "AS2",
  SourceIp: "STRING_VALUE",
  UserName: "STRING_VALUE", // required
  UserPassword: "STRING_VALUE",
};
const command = new TestIdentityProviderCommand(input);
const response = await client.send(command);
// { // TestIdentityProviderResponse
//   Response: "STRING_VALUE",
//   StatusCode: Number("int"), // required
//   Message: "STRING_VALUE",
//   Url: "STRING_VALUE", // required
// };

TestIdentityProviderCommand Input

See TestIdentityProviderCommandInput for more details

Parameter
Type
Description
ServerId
Required
string | undefined

A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.

UserName
Required
string | undefined

The name of the account to be tested.

ServerProtocol
Protocol | undefined

The type of file transfer protocol to be tested.

The available protocols are:

  • Secure Shell (SSH) File Transfer Protocol (SFTP)

  • File Transfer Protocol Secure (FTPS)

  • File Transfer Protocol (FTP)

  • Applicability Statement 2 (AS2)

SourceIp
string | undefined

The source IP address of the account to be tested.

UserPassword
string | undefined

The password of the account to be tested.

TestIdentityProviderCommand Output

See TestIdentityProviderCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
StatusCode
Required
number | undefined

The HTTP status code that is the response from your API Gateway or your Lambda function.

Url
Required
string | undefined

The endpoint of the service used to authenticate a user.

Message
string | undefined

A message that indicates whether the test was successful or not.

If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.

Response
string | undefined

The response that is returned from your API Gateway or your Lambda function.

Throws

Name
Fault
Details
InternalServiceError
server

This exception is thrown when an error occurs in the Transfer Family service.

InvalidRequestException
client

This exception is thrown when the client submits a malformed request.

ResourceNotFoundException
client

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

ServiceUnavailableException
server

The request has failed because the Amazon Web ServicesTransfer Family service is not available.

TransferServiceException
Base exception class for all service exceptions from Transfer service.