/AWS1/CL_TRN=>TESTIDENTITYPROVIDER()
¶
About TestIdentityProvider¶
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 theIdentityProviderType
of your server isSERVICE_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).
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_SERVERID
TYPE /AWS1/TRNSERVERID
/AWS1/TRNSERVERID
¶
A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.
IV_USERNAME
TYPE /AWS1/TRNUSERNAME
/AWS1/TRNUSERNAME
¶
The name of the account to be tested.
Optional arguments:¶
IV_SERVERPROTOCOL
TYPE /AWS1/TRNPROTOCOL
/AWS1/TRNPROTOCOL
¶
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)
IV_SOURCEIP
TYPE /AWS1/TRNSOURCEIP
/AWS1/TRNSOURCEIP
¶
The source IP address of the account to be tested.
IV_USERPASSWORD
TYPE /AWS1/TRNUSERPASSWORD
/AWS1/TRNUSERPASSWORD
¶
The password of the account to be tested.