IdentityProviderDetails - AWS Transfer Family


Returns information related to the type of user authentication that is in use for a file transfer protocol-enabled server's users. A server can have only one method of authentication.



The identifier of the AWS Directory Service directory that you want to use as your identity provider.

Type: String

Length Constraints: Fixed length of 12.

Pattern: d-[0-9a-f]{10}

Required: No


The ARN for a Lambda function to use for the Identity provider.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 170.

Pattern: arn:[a-z-]+:lambda:.*

Required: No


This parameter is only applicable if your IdentityProviderType is API_GATEWAY. Provides the type of InvocationRole used to authenticate the user account.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:.*role/\S+

Required: No


For SFTP-enabled servers, and for custom identity providers only, you can specify whether to authenticate using a password, SSH key pair, or both.

  • PASSWORD - users must provide their password to connect.

  • PUBLIC_KEY - users must provide their private key to connect.

  • PUBLIC_KEY_OR_PASSWORD - users can authenticate with either their password or their key. This is the default value.

  • PUBLIC_KEY_AND_PASSWORD - users must provide both their private key and their password to connect. The server checks the key first, and then if the key is valid, the system prompts for a password. If the private key provided does not match the public key that is stored, authentication fails.

Type: String


Required: No


Provides the location of the service endpoint used to authenticate users.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: