Skip to content

IdentityProviderDetails

Used by
Source code in docs_src/capo_transfer/types/identity_provider_details.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class IdentityProviderDetails(TypedDict, closed=True):
    url: NotRequired["capo_transfer.types.url.Url"]
    """<p>Provides the location of the service endpoint used to authenticate users.</p>"""
    invocation_role: NotRequired["capo_transfer.types.role.Role"]
    """<p>This parameter is only applicable if your <code>IdentityProviderType</code> is <code>API_GATEWAY</code>. Provides the type of <code>InvocationRole</code> used to authenticate the user account.</p>"""
    directory_id: NotRequired["capo_transfer.types.directory_id.DirectoryId"]
    """<p>The identifier of the Directory Service directory that you want to use as your identity provider.</p>"""
    function: NotRequired["capo_transfer.types.function.Function"]
    """<p>The ARN for a Lambda function to use for the Identity provider.</p>"""
    sftp_authentication_methods: NotRequired[
        "capo_transfer.types.sftp_authentication_methods.SftpAuthenticationMethods"
    ]
    """<p>For SFTP-enabled servers, and for custom identity providers <i>only</i>, you can specify whether to authenticate using a password, SSH key pair, or both.</p> <ul> <li> <p> <code>PASSWORD</code> - users must provide their password to connect.</p> </li> <li> <p> <code>PUBLIC_KEY</code> - users must provide their private key to connect.</p> </li> <li> <p> <code>PUBLIC_KEY_OR_PASSWORD</code> - users can authenticate with either their password or their key. This is the default value.</p> </li> <li> <p> <code>PUBLIC_KEY_AND_PASSWORD</code> - 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.</p> </li> </ul>"""

directory_id instance-attribute 

directory_id: NotRequired[DirectoryId]

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

function instance-attribute 

function: NotRequired[Function]

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

invocation_role instance-attribute 

invocation_role: NotRequired[Role]

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

sftp_authentication_methods instance-attribute 

sftp_authentication_methods: NotRequired[SftpAuthenticationMethods]

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.

url instance-attribute 

url: NotRequired[Url]

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