Skip to content

AuthParameter

Source code in docs_src/capo_appflow/types/auth_parameter.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class AuthParameter(TypedDict, closed=True):
    key: NotRequired["capo_appflow.types.key.Key"]
    """<p>The authentication key required to authenticate with the connector.</p>"""
    is_required: "capo_appflow.types.boolean.Boolean"
    """<p>Indicates whether this authentication parameter is required.</p>"""
    label: NotRequired["capo_appflow.types.label.Label"]
    """<p>Label used for authentication parameter.</p>"""
    description: NotRequired["capo_appflow.types.description.Description"]
    """<p>A description about the authentication parameter.</p>"""
    is_sensitive_field: "capo_appflow.types.boolean.Boolean"
    """<p>Indicates whether this authentication parameter is a sensitive field.</p>"""
    connector_supplied_values: NotRequired[
        "capo_appflow.types.connector_supplied_value_list.ConnectorSuppliedValueList"
    ]
    """<p>Contains default values for this authentication parameter that are supplied by the connector.</p>"""

connector_supplied_values instance-attribute 

connector_supplied_values: NotRequired[ConnectorSuppliedValueList]

Contains default values for this authentication parameter that are supplied by the connector.

description instance-attribute 

description: NotRequired[Description]

A description about the authentication parameter.

is_required instance-attribute 

is_required: Boolean

Indicates whether this authentication parameter is required.

is_sensitive_field instance-attribute 

is_sensitive_field: Boolean

Indicates whether this authentication parameter is a sensitive field.

key instance-attribute 

key: NotRequired[Key]

The authentication key required to authenticate with the connector.

label instance-attribute 

label: NotRequired[Label]

Label used for authentication parameter.