Run Type¶
ThemeOption¶
- ThemeOption =
- “actionSchedule” or“actionTriggerByData” or“actionTriggerByResource” or“actionTriggerByMQTT” or“alertDangerBackground” or“alertInfoBackground” or“alertWarningBackground” or“analysisExternal” or“analysisInternal” or“buttonDanger” or“buttonDangerText” or“buttonDefault” or“buttonDefaultText” or“buttonDisabled” or“buttonDisabledText” or“buttonIconLabel” or“buttonPrimary” or“buttonPrimaryText” or“buttonSuccess” or“buttonSuccessText” or“buttonWarning” or“buttonWarningText” or“deviceInputOutput1Day” or“deviceInputOutput3Days” or“deviceInputOutput3Hours” or“deviceInputOutput6Hours” or“deviceInputOutputRest” or“dottedBorder” or“dropdownAccent” or“dropdownBackground” or“floatingSidebarTitle” or“footerBackground” or“formControlBorder” or“gaugeEmpty” or“gaugeFill” or“gaugePrimaryText” or“gaugeSecondaryText” or“iconRadioSelected” or“iconRadioSubTitle” or“informationIcon” or“inputBackground” or“inputBackgroundReadOnly” or“inputError” or“inputForeground” or“inputForegroundReadOnly” or“lightBorder” or“limitAlert” or“link” or“listNavColor” or“listTitleLabel” or“loading” or“loginButton” or“loginButtonText” or“loginForeground” or“loginForm” or“modalContainer” or“modalOverlay” or“navbar” or“navbarBetaDeveloperBorder” or“navbarButton” or“navbarDropdownBorder” or“navbarDropdownOption” or“navbarDropdownOptionBorder” or“navbarText” or“navDescription” or“notificationButtonAmount” or“notificationButtonAmountText” or“notificationFilterBackground” or“notificationFooter” or“notificationItemBorder” or“notificationItemDate” or“notificationItemTextAccepted” or“notificationItemUnread” or“primary” or“publicPageNavigationBar” or“sidebarAccessSelected” or“sidebarAccountSelected” or“sidebarActionSelected” or“sidebarAnalysisSelected” or“sidebarBackground” or“sidebarBillingSelected” or“sidebarBucketSelected” or“sidebarDashboardSelected” or“sidebarDeviceSelected” or“sidebarExploreSelected” or“sidebarFileSelected” or“sidebarForegroundIcon” or“sidebarForegroundText” or“sidebarHomeSelected” or“sidebarItem” or“sidebarRibbon” or“sidebarRunSelected” or“sidebarSeparator” or“sidebarSeparatorForeground” or“sidebarUserSelected” or“snakeButtonOutline” or“svgTagoFont” or“svgTagoIOHole” or“switchDisabledBackground” or“switchSlider” or“tabBackground” or“tabLabelBorder” or“tooltipContainer” or“tooltipText” or“verticalTabItem” or“verticalTabItemBorder” or“widgetCardBackground” or“widgetIconsAccent” or“widgetIconsBackground” or“widgetIconsColor” or“widgetIconsFooterBasic” or“widgetIconsFooterPremium” or“auth_bg_opacity” or“auth_bg_src” or“auth_bg_type” or“auth_form_opacity”
signup_fields¶
Attributes:
name: strplaceholder: strrequired: booltype: str
feature_devicewifisetup¶
Attributes:
background_color: strbutton_cancel_background_color: strbutton_cancel_text_color: strbutton_confirm_background_color: strbutton_confirm_text_color: strenabled: boolip: strlanguage: strname: strport: strprotocol: strtext_color: strtranslations: Dict[str, object]
email_templates¶
Attributes:
subject: strvalue: str
TypedDict¶
Attributes:
subject: strvalue: str
feature_geolocation¶
Attributes:
buffer_size: Union[int, float]device: Union[str, None]enabled: boolmiddleware_url: strminimum_distance: Union[int, float]minimum_interval: Union[int, float]target: str
otp¶
Attributes:
authenticator: boolsms: boolemail: bool
RunInfo¶
Attributes:
profile: GenericIDactive: boolname: strsub_title: strurl: stremail_domain: Union[str, None]signup_method: strfavicon: Union[str, None]logo: Union[str, None]signup_logo: Union[str, None]signup_logo_options: objectsidebar_buttons: list[sidebar_buttons]signup_fields: list[signup_fields]email_templates: Dict[str, email_templates]feature_devicewifisetup: feature_devicewifisetupfeature_geolocation: feature_geolocationtheme: ThemeOptionintegration: objectsso_saml_active: boolsecurity: Dict[str, otp]
UserCreateInfo¶
Attributes:
name: stremail: strpassword**: strtimezone: strcompany: Optional[str]phone: Optional[str]language: Optional[str]tags: Optional[list[TagsObj]]active: Optional[bool]
UserInfo¶
Attributes:
name: stremail: strtimezone: strcompany: Optional[str]phone: Optional[str]language: Optional[str]tags: Optional[list[TagsObj]]active: Optional[bool]id: GenericIDprofile: GenericIDactive: boolnewsletter: boollast_login: Union[datetime, None]created_at: datetimeupdated_at: datetimeoptions: objecttags: list[TagsObj]
LoginResponse¶
Attributes:
token: GenericTokenexpire_date: ExpireTimeOption
LoginAsUserOptions¶
Attributes:
expire_time: Optional[str]Date to expire the login token.
- example:
SAMLAttributeMappings¶
Attributes:
email: strfirstName: strlastName: Optional[str]phone: Optional[str]company: Optional[str]language: Optional[str]timezone: Optional[str]tags: Dict[str, str]
sp¶
Attributes:
entity_id: stracs_url: strmetadata: str
idp¶
- Attributes:
RunSAMLInfo¶
Attributes:
sp: spInformation for TagoIO’s API routes to use as a Service Provider in SAML authentication flows.idp: idpRelevant information from the Identity Provider’s metadata after being parsed by TagoIO.mapping: SAMLAttributeMappingsAttribute mappings for the Identity Provider’s attributes to the attributes used in TagoIO.
RunSAMLEditInfo¶
Attributes:
idp_metadata: Optional[str]Identity Provider’s XML metadata encoded in a base 64 string.mapping: SAMLAttributeMappingsAttribute mappings for the Identity Provider’s attributes to the attributes used in TagoIO.
CustomDomainDnsRecord¶
Attributes:
status: boolStatus for the DNS record check.When true, the DNS record is properly configured with the provided key and value.When false, the DNS record is either not yet configured or the key exists but thevalue in the DNS record does not match the value provided.type: strType of the DNS record.key: strKey for key-value pair in the DNS record.value: strValue for the key-value pair the DNS record.current_value: Optional[str]Current value in the provider’s record for the DNS record’s key.Only returned when the DNS record has the matching key configured.When status is true, the value here will be the same as the one in value.When status is false, the value here can is either stale or there was an errorcopying the provided value in the DNS provider’s record.
CustomDomainResponse¶
Attributes:
Type for the Custom Domain response from the API, unparsed.:internalactive: boolWhether the custom domain is active.This is only true when all the required DNS records are properly configured in the DNS provider.domain: strConfigured domain for the RUN.subdomain: strConfigured subdomain for the RUN.email: strMailing address for the RUN with custom domain.dns_ssl: CustomDomainDnsRecordDNS record for the SSL certificate.The information in this record needs to be configured in the DNS provider for the custom domain.dns_page: CustomDomainDnsRecordDNS record for the page endpoint.The information in this record needs to be configured in the DNS provider for the custom domain.dns_email_1: CustomDomainDnsRecordFirst DNS record for the e-mail.The information in this record needs to be configured in the DNS provider for the custom domain.dns_email_2: CustomDomainDnsRecordSecond DNS record for the e-mail.The information in this record needs to be configured in the DNS provider for the custom domain.dns_email_3: CustomDomainDnsRecordThird DNS record for the e-mail.The information in this record needs to be configured in the DNS provider for the custom domain.created_at: strTimestamp (in string format) for when the custom domain was configured.
CustomDomainInfo¶
Attributes:
Type for the Custom Domain information in a profile’s RUN.active: boolWhether the custom domain is active.This is only true when all the required DNS records are properly configured in the DNSprovider.domain: strConfigured domain for the RUN.subdomain: strConfigured subdomain for the RUN.email: strMailing address for the RUN with custom domain.dns_ssl: CustomDomainDnsRecordDNS record for the SSL certificate.The information in this record needs to be configured in the DNS provider for the custom domain.dns_page: CustomDomainDnsRecordDNS record for the page endpoint.The information in this record needs to be configured in the DNS provider for the custom domain.dns_email_1: CustomDomainDnsRecordFirst DNS record for the e-mail.The information in this record needs to be configured in the DNS provider for the custom domain.dns_email_2: CustomDomainDnsRecordSecond DNS record for the e-mail.The information in this record needs to be configured in the DNS provider for the custom domain.dns_email_3: CustomDomainDnsRecordThird DNS record for the e-mail.The information in this record needs to be configured in the DNS provider for the custom domain.created_at: datetimeTimestamp for when the custom domain was configured.
CustomDomainCreate¶
Type for the data required to configure a profile’s RUN Custom Domain.
Attributes:
domain: strDomain for the RUN’s custom domain.If the desired custom domain is portal.mycompany.com, this will be “mycompany.com”.subdomain: strSubdomain for the RUN’s custom domain.If the desired custom domain is portal.mycompany.com, this will be “portal”.email: strMailing address for the RUN with custom domain.If the desired custom domain is portal.mycompany.com, this can be either “portal.mycompany.com” or “mycompany.com”.
