BasePlugin

BasePlugin fields

idstringRequired

The unique identifier for the plugin

typestringRequired

nameTypeValue

name: Reference TypeValue

descriptionTypeValue

description: Reference TypeValue

ownerPrincipal

owner: Reference Principal

resourceGroupsarray<ResourceGroup>

List of associated resource groups

Show children

entriesarray<PluginEntry>

List of plugin entries

Show children

supportsEventSubscriptionboolean

Whether the plugin supports event subscription

capabilitiesarray<DeviceInterface>

List of capabilities supported by the plugin

Show children

displayNamestring

Human-readable display name from plugin metadata (populated when expand=metadata)

iconstring

Icon identifier from plugin metadata (populated when expand=metadata)

authTypestring

Authentication type from plugin metadata (populated when expand=metadata). "API_KEY" accepts a single API key; "API_KEY_ENDPOINT" accepts both an API key and a custom endpoint URL (used for OpenAI-compatible providers where users bring their own base URL); "QR_CODE" uses an access-code + QR code scanning flow (e.g., Tuya Smart app).

Allowed values: OAUTH2, TWO_FACTOR, API_KEY, API_KEY_ENDPOINT, USERNAME_PASSWORD, QR_CODE, CODE_LINK, NONE.

oauthPluginMetadataOAuth

oauth: Reference PluginMetadataOAuth

multifactorPluginMetadataMultifactor

multifactor: Reference PluginMetadataMultifactor

capabilityInterfacesarray<PluginCapabilityInterface>

Capability interfaces from plugin metadata (populated when expand=metadata)

Show children

authorizationVariantsarray<PluginAuthorizationVariant>

Authorization variants the plugin supports (populated when expand=metadata)

Show children

regionalizationsarray<PluginRegionalization>

Regionalizations the plugin supports (populated when expand=metadata)

Show children