Auth0 Node.js SDK - v5.0.0
    Preparing search index...

    Interface IntegrationRequiredParam

    Param are form input values, primarily utilized when specifying secrets and configuration values for actions.

    These are especially important for partner integrations -- but can be exposed to tenant admins as well if they want to parameterize their custom actions.

    interface IntegrationRequiredParam {
        type?: Management.IntegrationRequiredParamTypeEnum;
        name?: string;
        required?: boolean;
        optional?: boolean;
        label?: string;
        description?: string;
        default_value?: string;
        placeholder?: string;
        options?: IntegrationRequiredParamOption[];
    }
    Index

    Properties

    type? name? required? optional? label? description? default_value? placeholder? options?

    Properties

    type?: Management.IntegrationRequiredParamTypeEnum
    name?: string

    The name of the parameter.

    required?: boolean

    The flag for if this parameter is required.

    optional?: boolean

    The temp flag for if this parameter is required (experimental; for Labs use only).

    label?: string

    The short label for this parameter.

    description?: string

    The lengthier description for this parameter.

    default_value?: string

    The default value for this parameter.

    placeholder?: string

    Placeholder text for this parameter.

    options?: IntegrationRequiredParamOption[]

    The allowable options for this param.

    Settings

    Member Visibility

    On This Page

    Properties