Skip to content

OAuth2CustomParameter

Source code in docs_src/capo_appflow/types/o_auth2_custom_parameter.py
class OAuth2CustomParameter(TypedDict, closed=True):
    key: NotRequired["capo_appflow.types.key.Key"]
    """<p>The key of the custom parameter required for OAuth 2.0 authentication.</p>"""
    is_required: "capo_appflow.types.boolean.Boolean"
    """<p>Indicates whether the custom parameter for OAuth 2.0 authentication is required.</p>"""
    label: NotRequired["capo_appflow.types.label.Label"]
    """<p>The label of the custom parameter used for OAuth 2.0 authentication.</p>"""
    description: NotRequired["capo_appflow.types.description.Description"]
    """<p>A description about the custom parameter used for OAuth 2.0 authentication.</p>"""
    is_sensitive_field: "capo_appflow.types.boolean.Boolean"
    """<p>Indicates whether this authentication custom 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>"""
    type: NotRequired[
        "capo_appflow.types.o_auth2_custom_prop_type.OAuth2CustomPropType"
    ]
    """<p>Indicates whether custom parameter is used with TokenUrl or AuthUrl.</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 custom parameter used for OAuth 2.0 authentication.

is_required instance-attribute

is_required: Boolean

Indicates whether the custom parameter for OAuth 2.0 authentication is required.

is_sensitive_field instance-attribute

is_sensitive_field: Boolean

Indicates whether this authentication custom parameter is a sensitive field.

key instance-attribute

key: NotRequired[Key]

The key of the custom parameter required for OAuth 2.0 authentication.

label instance-attribute

label: NotRequired[Label]

The label of the custom parameter used for OAuth 2.0 authentication.

type instance-attribute

type: NotRequired[OAuth2CustomPropType]

Indicates whether custom parameter is used with TokenUrl or AuthUrl.