docs/interfaces/management.Management.IntegrationRequiredParam.html
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[];
}
type?name?required?optional?label?description?default_value?placeholder?options?
Optionaltypetype?: Management.IntegrationRequiredParamTypeEnum
Optionalnamename?: string
The name of the parameter.
Optionalrequiredrequired?: boolean
The flag for if this parameter is required.
Optionaloptionaloptional?: boolean
The temp flag for if this parameter is required (experimental; for Labs use only).
Optionallabellabel?: string
The short label for this parameter.
Optionaldescriptiondescription?: string
The lengthier description for this parameter.
Optionaldefault_valuedefault_value?: string
The default value for this parameter.
Optionalplaceholderplaceholder?: string
Placeholder text for this parameter.
Optionaloptionsoptions?: IntegrationRequiredParamOption[]
The allowable options for this param.
Member Visibility
ThemeOSLightDark
Properties typenamerequiredoptionallabeldescriptiondefault_valueplaceholderoptions