Skip to content
Port OS

PluginAuthorizationVariant

HTTP API schema

← HTTP API reference

One way of authorizing a plugin, and what it needs from the customer.

PluginAuthorizationVariant fields

idstringRequired

The variant ID.

credentialSourcestringRequired

Whether Port OS or the customer owns the OAuth client.

Allowed values: PORT_OS, CUSTOMER.

regionalizationsarray<string>Required

IDs of the regionalizations this variant supports.

defaultRegionalizationstring

ID of the regionalization to preselect for this variant. Always one of this variant's regionalizations. Present whenever the variant offers more than one.

secretRolesarray<AuthLinkSecretRole>Required

Secret roles a link of this variant needs.

providerConfigurationstringRequired

The provider configuration this variant requires.

Allowed values: NONE, NEST_DEVICE_ACCESS.

guideSectionstring

Anchor of the documentation section describing how to set this variant up.

View source specification ↗