Class: Aws::Transfer::Types::IdentityProviderDetails

Inherits:

Struct

• Object
• Struct
• Aws::Transfer::Types::IdentityProviderDetails

Includes:

Structure

Defined in:

lib/aws-sdk-transfer/types.rb

Overview

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #directory_id ⇒ String

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

• #function ⇒ String

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

• #invocation_role ⇒ String

  This parameter is only applicable if your ‘IdentityProviderType` is `API_GATEWAY`.

• #sftp_authentication_methods ⇒ String

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

• #url ⇒ String

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

Instance Attribute Details

#directory_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 3294

class IdentityProviderDetails < Struct.new(
  :url,
  :invocation_role,
  :directory_id,
  :function,
  :sftp_authentication_methods)
  SENSITIVE = []
  include Aws::Structure
end

#function ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 3294

class IdentityProviderDetails < Struct.new(
  :url,
  :invocation_role,
  :directory_id,
  :function,
  :sftp_authentication_methods)
  SENSITIVE = []
  include Aws::Structure
end

#invocation_role ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 3294

class IdentityProviderDetails < Struct.new(
  :url,
  :invocation_role,
  :directory_id,
  :function,
  :sftp_authentication_methods)
  SENSITIVE = []
  include Aws::Structure
end

#sftp_authentication_methods ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 3294

class IdentityProviderDetails < Struct.new(
  :url,
  :invocation_role,
  :directory_id,
  :function,
  :sftp_authentication_methods)
  SENSITIVE = []
  include Aws::Structure
end

#url ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 3294

class IdentityProviderDetails < Struct.new(
  :url,
  :invocation_role,
  :directory_id,
  :function,
  :sftp_authentication_methods)
  SENSITIVE = []
  include Aws::Structure
end