Skip to content

CustomConnectorProfileCredentials

Source code in docs_src/capo_appflow/types/custom_connector_profile_credentials.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
class CustomConnectorProfileCredentials(TypedDict, closed=True):
    authentication_type: "capo_appflow.types.authentication_type.AuthenticationType"
    """<p>The authentication type that the custom connector uses for authenticating while creating a connector profile.</p>"""
    basic: NotRequired["capo_appflow.types.basic_auth_credentials.BasicAuthCredentials"]
    """<p>The basic credentials that are required for the authentication of the user.</p>"""
    oauth2: NotRequired["capo_appflow.types.o_auth2_credentials.OAuth2Credentials"]
    """<p>The OAuth 2.0 credentials required for the authentication of the user.</p>"""
    api_key: NotRequired["capo_appflow.types.api_key_credentials.ApiKeyCredentials"]
    """<p>The API keys required for the authentication of the user.</p>"""
    custom: NotRequired[
        "capo_appflow.types.custom_auth_credentials.CustomAuthCredentials"
    ]
    """<p>If the connector uses the custom authentication mechanism, this holds the required credentials.</p>"""

api_key instance-attribute 

api_key: NotRequired[ApiKeyCredentials]

The API keys required for the authentication of the user.

authentication_type instance-attribute 

authentication_type: AuthenticationType

The authentication type that the custom connector uses for authenticating while creating a connector profile.

basic instance-attribute 

basic: NotRequired[BasicAuthCredentials]

The basic credentials that are required for the authentication of the user.

custom instance-attribute 

custom: NotRequired[CustomAuthCredentials]

If the connector uses the custom authentication mechanism, this holds the required credentials.

oauth2 instance-attribute 

oauth2: NotRequired[OAuth2Credentials]

The OAuth 2.0 credentials required for the authentication of the user.