Skip to content

TestIdentityProviderRequest

Source code in docs_src/capo_transfer/types/test_identity_provider_request.py
class TestIdentityProviderRequest(TypedDict, closed=True):
    server_id: "capo_transfer.types.server_id.ServerId"
    """<p>A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.</p>"""
    server_protocol: NotRequired["capo_transfer.types.protocol.Protocol"]
    """<p>The type of file transfer protocol to be tested.</p> <p>The available protocols are:</p> <ul> <li> <p>Secure Shell (SSH) File Transfer Protocol (SFTP)</p> </li> <li> <p>File Transfer Protocol Secure (FTPS)</p> </li> <li> <p>File Transfer Protocol (FTP)</p> </li> <li> <p>Applicability Statement 2 (AS2)</p> </li> </ul>"""
    source_ip: NotRequired["capo_transfer.types.source_ip.SourceIp"]
    """<p>The source IP address of the account to be tested.</p>"""
    user_name: "capo_transfer.types.user_name.UserName"
    """<p>The name of the account to be tested.</p>"""
    user_password: NotRequired["capo_transfer.types.user_password.UserPassword"]
    """<p>The password of the account to be tested.</p>"""

server_id instance-attribute

server_id: ServerId

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

server_protocol instance-attribute

server_protocol: NotRequired[Protocol]

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)

source_ip instance-attribute

source_ip: NotRequired[SourceIp]

The source IP address of the account to be tested.

user_name instance-attribute

user_name: UserName

The name of the account to be tested.

user_password instance-attribute

user_password: NotRequired[UserPassword]

The password of the account to be tested.