1. Packages
  2. Unifi
  3. API Docs
  4. setting
  5. GuestAccess
Viewing docs for Unifi v0.2.0
published on Tuesday, Feb 17, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-unifi

unifi.setting.GuestAccess

unifi logo
Viewing docs for Unifi v0.2.0
published on Tuesday, Feb 17, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-unifi

    The unifi.setting.GuestAccess resource manages the guest access settings in the UniFi controller.

    This resource allows you to configure all aspects of guest network access including authentication methods, portal customization, and payment options.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as unifi from "@pulumiverse/unifi";

// Configure guest access settings for your UniFi network
// This example demonstrates a comprehensive guest portal setup with various authentication options
const logo = new unifi.port.AlFile("logo", {filePath: "logo.png"});
const guestPortal = new unifi.setting.GuestAccess("guest_portal", {
    auth: "hotspot",
    portalEnabled: true,
    portalUseHostname: true,
    portalHostname: "guest.example.com",
    templateEngine: "angular",
    expire: 1440,
    expireNumber: 1,
    expireUnit: 1440,
    ecEnabled: true,
    password: "guest-access-password",
    google: {
        clientId: "your-google-client-id",
        clientSecret: "your-google-client-secret",
        domain: "example.com",
        scopeEmail: true,
    },
    paymentGateway: "paypal",
    paypal: {
        username: "business@example.com",
        password: "paypal-api-password",
        signature: "paypal-api-signature",
        useSandbox: true,
    },
    redirect: {
        url: "https://example.com/welcome",
        useHttps: true,
        toHttps: true,
    },
    restrictedDnsServers: [
        "1.1.1.1",
        "8.8.8.8",
    ],
    portalCustomization: {
        customized: true,
        title: "Welcome to Our Guest Network",
        welcomeText: "Thanks for visiting our location. Please enjoy our complimentary WiFi.",
        welcomeTextEnabled: true,
        welcomeTextPosition: "top",
        bgColor: "#f5f5f5",
        textColor: "#333333",
        linkColor: "#0078d4",
        boxColor: "#ffffff",
        boxTextColor: "#333333",
        boxLinkColor: "#0078d4",
        boxOpacity: 90,
        boxRadius: 5,
        logoFileId: logo.id,
        buttonColor: "#0078d4",
        buttonTextColor: "#ffffff",
        buttonText: "Connect",
        tosEnabled: true,
        tos: "By using this service, you agree to our terms and conditions. Unauthorized use is prohibited.",
        languages: ["PL"],
    },
});

    import pulumi
import pulumiverse_unifi as unifi

# Configure guest access settings for your UniFi network
# This example demonstrates a comprehensive guest portal setup with various authentication options
logo = unifi.port.AlFile("logo", file_path="logo.png")
guest_portal = unifi.setting.GuestAccess("guest_portal",
    auth="hotspot",
    portal_enabled=True,
    portal_use_hostname=True,
    portal_hostname="guest.example.com",
    template_engine="angular",
    expire=1440,
    expire_number=1,
    expire_unit=1440,
    ec_enabled=True,
    password="guest-access-password",
    google={
        "client_id": "your-google-client-id",
        "client_secret": "your-google-client-secret",
        "domain": "example.com",
        "scope_email": True,
    },
    payment_gateway="paypal",
    paypal={
        "username": "business@example.com",
        "password": "paypal-api-password",
        "signature": "paypal-api-signature",
        "use_sandbox": True,
    },
    redirect={
        "url": "https://example.com/welcome",
        "use_https": True,
        "to_https": True,
    },
    restricted_dns_servers=[
        "1.1.1.1",
        "8.8.8.8",
    ],
    portal_customization={
        "customized": True,
        "title": "Welcome to Our Guest Network",
        "welcome_text": "Thanks for visiting our location. Please enjoy our complimentary WiFi.",
        "welcome_text_enabled": True,
        "welcome_text_position": "top",
        "bg_color": "#f5f5f5",
        "text_color": "#333333",
        "link_color": "#0078d4",
        "box_color": "#ffffff",
        "box_text_color": "#333333",
        "box_link_color": "#0078d4",
        "box_opacity": 90,
        "box_radius": 5,
        "logo_file_id": logo.id,
        "button_color": "#0078d4",
        "button_text_color": "#ffffff",
        "button_text": "Connect",
        "tos_enabled": True,
        "tos": "By using this service, you agree to our terms and conditions. Unauthorized use is prohibited.",
        "languages": ["PL"],
    })

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-unifi/sdk/go/unifi/port"
	"github.com/pulumiverse/pulumi-unifi/sdk/go/unifi/setting"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Configure guest access settings for your UniFi network
		// This example demonstrates a comprehensive guest portal setup with various authentication options
		logo, err := port.NewAlFile(ctx, "logo", &port.AlFileArgs{
			FilePath: pulumi.String("logo.png"),
		})
		if err != nil {
			return err
		}
		_, err = setting.NewGuestAccess(ctx, "guest_portal", &setting.GuestAccessArgs{
			Auth:              pulumi.String("hotspot"),
			PortalEnabled:     pulumi.Bool(true),
			PortalUseHostname: pulumi.Bool(true),
			PortalHostname:    pulumi.String("guest.example.com"),
			TemplateEngine:    pulumi.String("angular"),
			Expire:            pulumi.Int(1440),
			ExpireNumber:      pulumi.Int(1),
			ExpireUnit:        pulumi.Int(1440),
			EcEnabled:         pulumi.Bool(true),
			Password:          pulumi.String("guest-access-password"),
			Google: &setting.GuestAccessGoogleArgs{
				ClientId:     pulumi.String("your-google-client-id"),
				ClientSecret: pulumi.String("your-google-client-secret"),
				Domain:       pulumi.String("example.com"),
				ScopeEmail:   pulumi.Bool(true),
			},
			PaymentGateway: pulumi.String("paypal"),
			Paypal: &setting.GuestAccessPaypalArgs{
				Username:   pulumi.String("business@example.com"),
				Password:   pulumi.String("paypal-api-password"),
				Signature:  pulumi.String("paypal-api-signature"),
				UseSandbox: pulumi.Bool(true),
			},
			Redirect: &setting.GuestAccessRedirectArgs{
				Url:      pulumi.String("https://example.com/welcome"),
				UseHttps: pulumi.Bool(true),
				ToHttps:  pulumi.Bool(true),
			},
			RestrictedDnsServers: pulumi.StringArray{
				pulumi.String("1.1.1.1"),
				pulumi.String("8.8.8.8"),
			},
			PortalCustomization: &setting.GuestAccessPortalCustomizationArgs{
				Customized:          pulumi.Bool(true),
				Title:               pulumi.String("Welcome to Our Guest Network"),
				WelcomeText:         pulumi.String("Thanks for visiting our location. Please enjoy our complimentary WiFi."),
				WelcomeTextEnabled:  pulumi.Bool(true),
				WelcomeTextPosition: pulumi.String("top"),
				BgColor:             pulumi.String("#f5f5f5"),
				TextColor:           pulumi.String("#333333"),
				LinkColor:           pulumi.String("#0078d4"),
				BoxColor:            pulumi.String("#ffffff"),
				BoxTextColor:        pulumi.String("#333333"),
				BoxLinkColor:        pulumi.String("#0078d4"),
				BoxOpacity:          pulumi.Int(90),
				BoxRadius:           pulumi.Int(5),
				LogoFileId:          logo.ID(),
				ButtonColor:         pulumi.String("#0078d4"),
				ButtonTextColor:     pulumi.String("#ffffff"),
				ButtonText:          pulumi.String("Connect"),
				TosEnabled:          pulumi.Bool(true),
				Tos:                 pulumi.String("By using this service, you agree to our terms and conditions. Unauthorized use is prohibited."),
				Languages: pulumi.StringArray{
					pulumi.String("PL"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Unifi = Pulumiverse.Unifi;

return await Deployment.RunAsync(() => 
{
    // Configure guest access settings for your UniFi network
    // This example demonstrates a comprehensive guest portal setup with various authentication options
    var logo = new Unifi.Port.AlFile("logo", new()
    {
        FilePath = "logo.png",
    });

    var guestPortal = new Unifi.Setting.GuestAccess("guest_portal", new()
    {
        Auth = "hotspot",
        PortalEnabled = true,
        PortalUseHostname = true,
        PortalHostname = "guest.example.com",
        TemplateEngine = "angular",
        Expire = 1440,
        ExpireNumber = 1,
        ExpireUnit = 1440,
        EcEnabled = true,
        Password = "guest-access-password",
        Google = new Unifi.Setting.Inputs.GuestAccessGoogleArgs
        {
            ClientId = "your-google-client-id",
            ClientSecret = "your-google-client-secret",
            Domain = "example.com",
            ScopeEmail = true,
        },
        PaymentGateway = "paypal",
        Paypal = new Unifi.Setting.Inputs.GuestAccessPaypalArgs
        {
            Username = "business@example.com",
            Password = "paypal-api-password",
            Signature = "paypal-api-signature",
            UseSandbox = true,
        },
        Redirect = new Unifi.Setting.Inputs.GuestAccessRedirectArgs
        {
            Url = "https://example.com/welcome",
            UseHttps = true,
            ToHttps = true,
        },
        RestrictedDnsServers = new[]
        {
            "1.1.1.1",
            "8.8.8.8",
        },
        PortalCustomization = new Unifi.Setting.Inputs.GuestAccessPortalCustomizationArgs
        {
            Customized = true,
            Title = "Welcome to Our Guest Network",
            WelcomeText = "Thanks for visiting our location. Please enjoy our complimentary WiFi.",
            WelcomeTextEnabled = true,
            WelcomeTextPosition = "top",
            BgColor = "#f5f5f5",
            TextColor = "#333333",
            LinkColor = "#0078d4",
            BoxColor = "#ffffff",
            BoxTextColor = "#333333",
            BoxLinkColor = "#0078d4",
            BoxOpacity = 90,
            BoxRadius = 5,
            LogoFileId = logo.Id,
            ButtonColor = "#0078d4",
            ButtonTextColor = "#ffffff",
            ButtonText = "Connect",
            TosEnabled = true,
            Tos = "By using this service, you agree to our terms and conditions. Unauthorized use is prohibited.",
            Languages = new[]
            {
                "PL",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumiverse.unifi.port.AlFile;
import com.pulumiverse.unifi.port.AlFileArgs;
import com.pulumiverse.unifi.setting.GuestAccess;
import com.pulumiverse.unifi.setting.GuestAccessArgs;
import com.pulumi.unifi.setting.inputs.GuestAccessGoogleArgs;
import com.pulumi.unifi.setting.inputs.GuestAccessPaypalArgs;
import com.pulumi.unifi.setting.inputs.GuestAccessRedirectArgs;
import com.pulumi.unifi.setting.inputs.GuestAccessPortalCustomizationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Configure guest access settings for your UniFi network
        // This example demonstrates a comprehensive guest portal setup with various authentication options
        var logo = new AlFile("logo", AlFileArgs.builder()
            .filePath("logo.png")
            .build());

        var guestPortal = new GuestAccess("guestPortal", GuestAccessArgs.builder()
            .auth("hotspot")
            .portalEnabled(true)
            .portalUseHostname(true)
            .portalHostname("guest.example.com")
            .templateEngine("angular")
            .expire(1440)
            .expireNumber(1)
            .expireUnit(1440)
            .ecEnabled(true)
            .password("guest-access-password")
            .google(GuestAccessGoogleArgs.builder()
                .clientId("your-google-client-id")
                .clientSecret("your-google-client-secret")
                .domain("example.com")
                .scopeEmail(true)
                .build())
            .paymentGateway("paypal")
            .paypal(GuestAccessPaypalArgs.builder()
                .username("business@example.com")
                .password("paypal-api-password")
                .signature("paypal-api-signature")
                .useSandbox(true)
                .build())
            .redirect(GuestAccessRedirectArgs.builder()
                .url("https://example.com/welcome")
                .useHttps(true)
                .toHttps(true)
                .build())
            .restrictedDnsServers(            
                "1.1.1.1",
                "8.8.8.8")
            .portalCustomization(GuestAccessPortalCustomizationArgs.builder()
                .customized(true)
                .title("Welcome to Our Guest Network")
                .welcomeText("Thanks for visiting our location. Please enjoy our complimentary WiFi.")
                .welcomeTextEnabled(true)
                .welcomeTextPosition("top")
                .bgColor("#f5f5f5")
                .textColor("#333333")
                .linkColor("#0078d4")
                .boxColor("#ffffff")
                .boxTextColor("#333333")
                .boxLinkColor("#0078d4")
                .boxOpacity(90)
                .boxRadius(5)
                .logoFileId(logo.id())
                .buttonColor("#0078d4")
                .buttonTextColor("#ffffff")
                .buttonText("Connect")
                .tosEnabled(true)
                .tos("By using this service, you agree to our terms and conditions. Unauthorized use is prohibited.")
                .languages("PL")
                .build())
            .build());

    }
}

    resources:
  # Configure guest access settings for your UniFi network
  # This example demonstrates a comprehensive guest portal setup with various authentication options
  logo:
    type: unifi:port:AlFile
    properties:
      filePath: logo.png
  guestPortal:
    type: unifi:setting:GuestAccess
    name: guest_portal
    properties:
      auth: hotspot
      portalEnabled: true # Enable the guest portal
      portalUseHostname: true # Use hostname for the portal
      portalHostname: guest.example.com
      templateEngine: angular
      expire: 1440 # Minutes until expiration
      expireNumber: 1 # Number of time units
      expireUnit: 1440 # Enable external captive portal detection
      ecEnabled: true # Password protection for guest access
      password: guest-access-password
      google:
        clientId: your-google-client-id
        clientSecret: your-google-client-secret
        domain: example.com
        scopeEmail: true
      paymentGateway: paypal
      paypal:
        username: business@example.com
        password: paypal-api-password
        signature: paypal-api-signature
        useSandbox: true
      redirect:
        url: https://example.com/welcome
        useHttps: true
        toHttps: true
      restrictedDnsServers:
        - 1.1.1.1
        - 8.8.8.8
      portalCustomization:
        customized: true
        title: Welcome to Our Guest Network
        welcomeText: Thanks for visiting our location. Please enjoy our complimentary WiFi.
        welcomeTextEnabled: true
        welcomeTextPosition: top
        bgColor: '#f5f5f5'
        textColor: '#333333'
        linkColor: '#0078d4'
        boxColor: '#ffffff'
        boxTextColor: '#333333'
        boxLinkColor: '#0078d4'
        boxOpacity: 90
        boxRadius: 5
        logoFileId: ${logo.id}
        buttonColor: '#0078d4'
        buttonTextColor: '#ffffff'
        buttonText: Connect
        tosEnabled: true
        tos: By using this service, you agree to our terms and conditions. Unauthorized use is prohibited.
        languages:
          - PL

    Create GuestAccess Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GuestAccess(name: string, args?: GuestAccessArgs, opts?: CustomResourceOptions);
    @overload
def GuestAccess(resource_name: str,
                args: Optional[GuestAccessArgs] = None,
                opts: Optional[ResourceOptions] = None)

@overload
def GuestAccess(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                allowed_subnet: Optional[str] = None,
                auth: Optional[str] = None,
                auth_url: Optional[str] = None,
                authorize: Optional[GuestAccessAuthorizeArgs] = None,
                custom_ip: Optional[str] = None,
                ec_enabled: Optional[bool] = None,
                expire: Optional[int] = None,
                expire_number: Optional[int] = None,
                expire_unit: Optional[int] = None,
                facebook: Optional[GuestAccessFacebookArgs] = None,
                facebook_wifi: Optional[GuestAccessFacebookWifiArgs] = None,
                google: Optional[GuestAccessGoogleArgs] = None,
                ippay: Optional[GuestAccessIppayArgs] = None,
                merchant_warrior: Optional[GuestAccessMerchantWarriorArgs] = None,
                password: Optional[str] = None,
                payment_gateway: Optional[str] = None,
                paypal: Optional[GuestAccessPaypalArgs] = None,
                portal_customization: Optional[GuestAccessPortalCustomizationArgs] = None,
                portal_enabled: Optional[bool] = None,
                portal_hostname: Optional[str] = None,
                portal_use_hostname: Optional[bool] = None,
                quickpay: Optional[GuestAccessQuickpayArgs] = None,
                radius: Optional[GuestAccessRadiusArgs] = None,
                redirect: Optional[GuestAccessRedirectArgs] = None,
                restricted_dns_servers: Optional[Sequence[str]] = None,
                restricted_subnet: Optional[str] = None,
                site: Optional[str] = None,
                stripe: Optional[GuestAccessStripeArgs] = None,
                template_engine: Optional[str] = None,
                voucher_customized: Optional[bool] = None,
                voucher_enabled: Optional[bool] = None,
                wechat: Optional[GuestAccessWechatArgs] = None)
    func NewGuestAccess(ctx *Context, name string, args *GuestAccessArgs, opts ...ResourceOption) (*GuestAccess, error)
    public GuestAccess(string name, GuestAccessArgs? args = null, CustomResourceOptions? opts = null)
    public GuestAccess(String name, GuestAccessArgs args)
public GuestAccess(String name, GuestAccessArgs args, CustomResourceOptions options)

    type: unifi:setting:GuestAccess
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GuestAccessArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GuestAccessArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GuestAccessArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GuestAccessArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GuestAccessArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var guestAccessResource = new Unifi.Setting.GuestAccess("guestAccessResource", new()
{
    AllowedSubnet = "string",
    Auth = "string",
    AuthUrl = "string",
    Authorize = new Unifi.Setting.Inputs.GuestAccessAuthorizeArgs
    {
        LoginId = "string",
        TransactionKey = "string",
        UseSandbox = false,
    },
    CustomIp = "string",
    EcEnabled = false,
    Expire = 0,
    ExpireNumber = 0,
    ExpireUnit = 0,
    Facebook = new Unifi.Setting.Inputs.GuestAccessFacebookArgs
    {
        AppId = "string",
        AppSecret = "string",
        ScopeEmail = false,
    },
    FacebookWifi = new Unifi.Setting.Inputs.GuestAccessFacebookWifiArgs
    {
        GatewayId = "string",
        GatewayName = "string",
        GatewaySecret = "string",
        BlockHttps = false,
    },
    Google = new Unifi.Setting.Inputs.GuestAccessGoogleArgs
    {
        ClientId = "string",
        ClientSecret = "string",
        Domain = "string",
        ScopeEmail = false,
    },
    Ippay = new Unifi.Setting.Inputs.GuestAccessIppayArgs
    {
        TerminalId = "string",
        UseSandbox = false,
    },
    MerchantWarrior = new Unifi.Setting.Inputs.GuestAccessMerchantWarriorArgs
    {
        ApiKey = "string",
        ApiPassphrase = "string",
        MerchantUuid = "string",
        UseSandbox = false,
    },
    Password = "string",
    PaymentGateway = "string",
    Paypal = new Unifi.Setting.Inputs.GuestAccessPaypalArgs
    {
        Password = "string",
        Signature = "string",
        Username = "string",
        UseSandbox = false,
    },
    PortalCustomization = new Unifi.Setting.Inputs.GuestAccessPortalCustomizationArgs
    {
        AuthenticationText = "string",
        BgColor = "string",
        BgImageFileId = "string",
        BgImageTile = false,
        BgType = "string",
        BoxColor = "string",
        BoxLinkColor = "string",
        BoxOpacity = 0,
        BoxRadius = 0,
        BoxTextColor = "string",
        ButtonColor = "string",
        ButtonText = "string",
        ButtonTextColor = "string",
        Customized = false,
        Languages = new[]
        {
            "string",
        },
        LinkColor = "string",
        LogoFileId = "string",
        LogoPosition = "string",
        LogoSize = 0,
        SuccessText = "string",
        TextColor = "string",
        Title = "string",
        Tos = "string",
        TosEnabled = false,
        UnsplashAuthorName = "string",
        UnsplashAuthorUsername = "string",
        WelcomeText = "string",
        WelcomeTextEnabled = false,
        WelcomeTextPosition = "string",
    },
    PortalEnabled = false,
    PortalHostname = "string",
    PortalUseHostname = false,
    Quickpay = new Unifi.Setting.Inputs.GuestAccessQuickpayArgs
    {
        AgreementId = "string",
        ApiKey = "string",
        MerchantId = "string",
        UseSandbox = false,
    },
    Radius = new Unifi.Setting.Inputs.GuestAccessRadiusArgs
    {
        AuthType = "string",
        ProfileId = "string",
        DisconnectEnabled = false,
        DisconnectPort = 0,
    },
    Redirect = new Unifi.Setting.Inputs.GuestAccessRedirectArgs
    {
        Url = "string",
        ToHttps = false,
        UseHttps = false,
    },
    RestrictedDnsServers = new[]
    {
        "string",
    },
    RestrictedSubnet = "string",
    Site = "string",
    Stripe = new Unifi.Setting.Inputs.GuestAccessStripeArgs
    {
        ApiKey = "string",
    },
    TemplateEngine = "string",
    VoucherCustomized = false,
    VoucherEnabled = false,
    Wechat = new Unifi.Setting.Inputs.GuestAccessWechatArgs
    {
        AppId = "string",
        AppSecret = "string",
        SecretKey = "string",
        ShopId = "string",
    },
});

    example, err := setting.NewGuestAccess(ctx, "guestAccessResource", &setting.GuestAccessArgs{
	AllowedSubnet: pulumi.String("string"),
	Auth:          pulumi.String("string"),
	AuthUrl:       pulumi.String("string"),
	Authorize: &setting.GuestAccessAuthorizeArgs{
		LoginId:        pulumi.String("string"),
		TransactionKey: pulumi.String("string"),
		UseSandbox:     pulumi.Bool(false),
	},
	CustomIp:     pulumi.String("string"),
	EcEnabled:    pulumi.Bool(false),
	Expire:       pulumi.Int(0),
	ExpireNumber: pulumi.Int(0),
	ExpireUnit:   pulumi.Int(0),
	Facebook: &setting.GuestAccessFacebookArgs{
		AppId:      pulumi.String("string"),
		AppSecret:  pulumi.String("string"),
		ScopeEmail: pulumi.Bool(false),
	},
	FacebookWifi: &setting.GuestAccessFacebookWifiArgs{
		GatewayId:     pulumi.String("string"),
		GatewayName:   pulumi.String("string"),
		GatewaySecret: pulumi.String("string"),
		BlockHttps:    pulumi.Bool(false),
	},
	Google: &setting.GuestAccessGoogleArgs{
		ClientId:     pulumi.String("string"),
		ClientSecret: pulumi.String("string"),
		Domain:       pulumi.String("string"),
		ScopeEmail:   pulumi.Bool(false),
	},
	Ippay: &setting.GuestAccessIppayArgs{
		TerminalId: pulumi.String("string"),
		UseSandbox: pulumi.Bool(false),
	},
	MerchantWarrior: &setting.GuestAccessMerchantWarriorArgs{
		ApiKey:        pulumi.String("string"),
		ApiPassphrase: pulumi.String("string"),
		MerchantUuid:  pulumi.String("string"),
		UseSandbox:    pulumi.Bool(false),
	},
	Password:       pulumi.String("string"),
	PaymentGateway: pulumi.String("string"),
	Paypal: &setting.GuestAccessPaypalArgs{
		Password:   pulumi.String("string"),
		Signature:  pulumi.String("string"),
		Username:   pulumi.String("string"),
		UseSandbox: pulumi.Bool(false),
	},
	PortalCustomization: &setting.GuestAccessPortalCustomizationArgs{
		AuthenticationText: pulumi.String("string"),
		BgColor:            pulumi.String("string"),
		BgImageFileId:      pulumi.String("string"),
		BgImageTile:        pulumi.Bool(false),
		BgType:             pulumi.String("string"),
		BoxColor:           pulumi.String("string"),
		BoxLinkColor:       pulumi.String("string"),
		BoxOpacity:         pulumi.Int(0),
		BoxRadius:          pulumi.Int(0),
		BoxTextColor:       pulumi.String("string"),
		ButtonColor:        pulumi.String("string"),
		ButtonText:         pulumi.String("string"),
		ButtonTextColor:    pulumi.String("string"),
		Customized:         pulumi.Bool(false),
		Languages: pulumi.StringArray{
			pulumi.String("string"),
		},
		LinkColor:              pulumi.String("string"),
		LogoFileId:             pulumi.String("string"),
		LogoPosition:           pulumi.String("string"),
		LogoSize:               pulumi.Int(0),
		SuccessText:            pulumi.String("string"),
		TextColor:              pulumi.String("string"),
		Title:                  pulumi.String("string"),
		Tos:                    pulumi.String("string"),
		TosEnabled:             pulumi.Bool(false),
		UnsplashAuthorName:     pulumi.String("string"),
		UnsplashAuthorUsername: pulumi.String("string"),
		WelcomeText:            pulumi.String("string"),
		WelcomeTextEnabled:     pulumi.Bool(false),
		WelcomeTextPosition:    pulumi.String("string"),
	},
	PortalEnabled:     pulumi.Bool(false),
	PortalHostname:    pulumi.String("string"),
	PortalUseHostname: pulumi.Bool(false),
	Quickpay: &setting.GuestAccessQuickpayArgs{
		AgreementId: pulumi.String("string"),
		ApiKey:      pulumi.String("string"),
		MerchantId:  pulumi.String("string"),
		UseSandbox:  pulumi.Bool(false),
	},
	Radius: &setting.GuestAccessRadiusArgs{
		AuthType:          pulumi.String("string"),
		ProfileId:         pulumi.String("string"),
		DisconnectEnabled: pulumi.Bool(false),
		DisconnectPort:    pulumi.Int(0),
	},
	Redirect: &setting.GuestAccessRedirectArgs{
		Url:      pulumi.String("string"),
		ToHttps:  pulumi.Bool(false),
		UseHttps: pulumi.Bool(false),
	},
	RestrictedDnsServers: pulumi.StringArray{
		pulumi.String("string"),
	},
	RestrictedSubnet: pulumi.String("string"),
	Site:             pulumi.String("string"),
	Stripe: &setting.GuestAccessStripeArgs{
		ApiKey: pulumi.String("string"),
	},
	TemplateEngine:    pulumi.String("string"),
	VoucherCustomized: pulumi.Bool(false),
	VoucherEnabled:    pulumi.Bool(false),
	Wechat: &setting.GuestAccessWechatArgs{
		AppId:     pulumi.String("string"),
		AppSecret: pulumi.String("string"),
		SecretKey: pulumi.String("string"),
		ShopId:    pulumi.String("string"),
	},
})

    var guestAccessResource = new GuestAccess("guestAccessResource", GuestAccessArgs.builder()
    .allowedSubnet("string")
    .auth("string")
    .authUrl("string")
    .authorize(GuestAccessAuthorizeArgs.builder()
        .loginId("string")
        .transactionKey("string")
        .useSandbox(false)
        .build())
    .customIp("string")
    .ecEnabled(false)
    .expire(0)
    .expireNumber(0)
    .expireUnit(0)
    .facebook(GuestAccessFacebookArgs.builder()
        .appId("string")
        .appSecret("string")
        .scopeEmail(false)
        .build())
    .facebookWifi(GuestAccessFacebookWifiArgs.builder()
        .gatewayId("string")
        .gatewayName("string")
        .gatewaySecret("string")
        .blockHttps(false)
        .build())
    .google(GuestAccessGoogleArgs.builder()
        .clientId("string")
        .clientSecret("string")
        .domain("string")
        .scopeEmail(false)
        .build())
    .ippay(GuestAccessIppayArgs.builder()
        .terminalId("string")
        .useSandbox(false)
        .build())
    .merchantWarrior(GuestAccessMerchantWarriorArgs.builder()
        .apiKey("string")
        .apiPassphrase("string")
        .merchantUuid("string")
        .useSandbox(false)
        .build())
    .password("string")
    .paymentGateway("string")
    .paypal(GuestAccessPaypalArgs.builder()
        .password("string")
        .signature("string")
        .username("string")
        .useSandbox(false)
        .build())
    .portalCustomization(GuestAccessPortalCustomizationArgs.builder()
        .authenticationText("string")
        .bgColor("string")
        .bgImageFileId("string")
        .bgImageTile(false)
        .bgType("string")
        .boxColor("string")
        .boxLinkColor("string")
        .boxOpacity(0)
        .boxRadius(0)
        .boxTextColor("string")
        .buttonColor("string")
        .buttonText("string")
        .buttonTextColor("string")
        .customized(false)
        .languages("string")
        .linkColor("string")
        .logoFileId("string")
        .logoPosition("string")
        .logoSize(0)
        .successText("string")
        .textColor("string")
        .title("string")
        .tos("string")
        .tosEnabled(false)
        .unsplashAuthorName("string")
        .unsplashAuthorUsername("string")
        .welcomeText("string")
        .welcomeTextEnabled(false)
        .welcomeTextPosition("string")
        .build())
    .portalEnabled(false)
    .portalHostname("string")
    .portalUseHostname(false)
    .quickpay(GuestAccessQuickpayArgs.builder()
        .agreementId("string")
        .apiKey("string")
        .merchantId("string")
        .useSandbox(false)
        .build())
    .radius(GuestAccessRadiusArgs.builder()
        .authType("string")
        .profileId("string")
        .disconnectEnabled(false)
        .disconnectPort(0)
        .build())
    .redirect(GuestAccessRedirectArgs.builder()
        .url("string")
        .toHttps(false)
        .useHttps(false)
        .build())
    .restrictedDnsServers("string")
    .restrictedSubnet("string")
    .site("string")
    .stripe(GuestAccessStripeArgs.builder()
        .apiKey("string")
        .build())
    .templateEngine("string")
    .voucherCustomized(false)
    .voucherEnabled(false)
    .wechat(GuestAccessWechatArgs.builder()
        .appId("string")
        .appSecret("string")
        .secretKey("string")
        .shopId("string")
        .build())
    .build());

    guest_access_resource = unifi.setting.GuestAccess("guestAccessResource",
    allowed_subnet="string",
    auth="string",
    auth_url="string",
    authorize={
        "login_id": "string",
        "transaction_key": "string",
        "use_sandbox": False,
    },
    custom_ip="string",
    ec_enabled=False,
    expire=0,
    expire_number=0,
    expire_unit=0,
    facebook={
        "app_id": "string",
        "app_secret": "string",
        "scope_email": False,
    },
    facebook_wifi={
        "gateway_id": "string",
        "gateway_name": "string",
        "gateway_secret": "string",
        "block_https": False,
    },
    google={
        "client_id": "string",
        "client_secret": "string",
        "domain": "string",
        "scope_email": False,
    },
    ippay={
        "terminal_id": "string",
        "use_sandbox": False,
    },
    merchant_warrior={
        "api_key": "string",
        "api_passphrase": "string",
        "merchant_uuid": "string",
        "use_sandbox": False,
    },
    password="string",
    payment_gateway="string",
    paypal={
        "password": "string",
        "signature": "string",
        "username": "string",
        "use_sandbox": False,
    },
    portal_customization={
        "authentication_text": "string",
        "bg_color": "string",
        "bg_image_file_id": "string",
        "bg_image_tile": False,
        "bg_type": "string",
        "box_color": "string",
        "box_link_color": "string",
        "box_opacity": 0,
        "box_radius": 0,
        "box_text_color": "string",
        "button_color": "string",
        "button_text": "string",
        "button_text_color": "string",
        "customized": False,
        "languages": ["string"],
        "link_color": "string",
        "logo_file_id": "string",
        "logo_position": "string",
        "logo_size": 0,
        "success_text": "string",
        "text_color": "string",
        "title": "string",
        "tos": "string",
        "tos_enabled": False,
        "unsplash_author_name": "string",
        "unsplash_author_username": "string",
        "welcome_text": "string",
        "welcome_text_enabled": False,
        "welcome_text_position": "string",
    },
    portal_enabled=False,
    portal_hostname="string",
    portal_use_hostname=False,
    quickpay={
        "agreement_id": "string",
        "api_key": "string",
        "merchant_id": "string",
        "use_sandbox": False,
    },
    radius={
        "auth_type": "string",
        "profile_id": "string",
        "disconnect_enabled": False,
        "disconnect_port": 0,
    },
    redirect={
        "url": "string",
        "to_https": False,
        "use_https": False,
    },
    restricted_dns_servers=["string"],
    restricted_subnet="string",
    site="string",
    stripe={
        "api_key": "string",
    },
    template_engine="string",
    voucher_customized=False,
    voucher_enabled=False,
    wechat={
        "app_id": "string",
        "app_secret": "string",
        "secret_key": "string",
        "shop_id": "string",
    })

    const guestAccessResource = new unifi.setting.GuestAccess("guestAccessResource", {
    allowedSubnet: "string",
    auth: "string",
    authUrl: "string",
    authorize: {
        loginId: "string",
        transactionKey: "string",
        useSandbox: false,
    },
    customIp: "string",
    ecEnabled: false,
    expire: 0,
    expireNumber: 0,
    expireUnit: 0,
    facebook: {
        appId: "string",
        appSecret: "string",
        scopeEmail: false,
    },
    facebookWifi: {
        gatewayId: "string",
        gatewayName: "string",
        gatewaySecret: "string",
        blockHttps: false,
    },
    google: {
        clientId: "string",
        clientSecret: "string",
        domain: "string",
        scopeEmail: false,
    },
    ippay: {
        terminalId: "string",
        useSandbox: false,
    },
    merchantWarrior: {
        apiKey: "string",
        apiPassphrase: "string",
        merchantUuid: "string",
        useSandbox: false,
    },
    password: "string",
    paymentGateway: "string",
    paypal: {
        password: "string",
        signature: "string",
        username: "string",
        useSandbox: false,
    },
    portalCustomization: {
        authenticationText: "string",
        bgColor: "string",
        bgImageFileId: "string",
        bgImageTile: false,
        bgType: "string",
        boxColor: "string",
        boxLinkColor: "string",
        boxOpacity: 0,
        boxRadius: 0,
        boxTextColor: "string",
        buttonColor: "string",
        buttonText: "string",
        buttonTextColor: "string",
        customized: false,
        languages: ["string"],
        linkColor: "string",
        logoFileId: "string",
        logoPosition: "string",
        logoSize: 0,
        successText: "string",
        textColor: "string",
        title: "string",
        tos: "string",
        tosEnabled: false,
        unsplashAuthorName: "string",
        unsplashAuthorUsername: "string",
        welcomeText: "string",
        welcomeTextEnabled: false,
        welcomeTextPosition: "string",
    },
    portalEnabled: false,
    portalHostname: "string",
    portalUseHostname: false,
    quickpay: {
        agreementId: "string",
        apiKey: "string",
        merchantId: "string",
        useSandbox: false,
    },
    radius: {
        authType: "string",
        profileId: "string",
        disconnectEnabled: false,
        disconnectPort: 0,
    },
    redirect: {
        url: "string",
        toHttps: false,
        useHttps: false,
    },
    restrictedDnsServers: ["string"],
    restrictedSubnet: "string",
    site: "string",
    stripe: {
        apiKey: "string",
    },
    templateEngine: "string",
    voucherCustomized: false,
    voucherEnabled: false,
    wechat: {
        appId: "string",
        appSecret: "string",
        secretKey: "string",
        shopId: "string",
    },
});

    type: unifi:setting:GuestAccess
properties:
    allowedSubnet: string
    auth: string
    authUrl: string
    authorize:
        loginId: string
        transactionKey: string
        useSandbox: false
    customIp: string
    ecEnabled: false
    expire: 0
    expireNumber: 0
    expireUnit: 0
    facebook:
        appId: string
        appSecret: string
        scopeEmail: false
    facebookWifi:
        blockHttps: false
        gatewayId: string
        gatewayName: string
        gatewaySecret: string
    google:
        clientId: string
        clientSecret: string
        domain: string
        scopeEmail: false
    ippay:
        terminalId: string
        useSandbox: false
    merchantWarrior:
        apiKey: string
        apiPassphrase: string
        merchantUuid: string
        useSandbox: false
    password: string
    paymentGateway: string
    paypal:
        password: string
        signature: string
        useSandbox: false
        username: string
    portalCustomization:
        authenticationText: string
        bgColor: string
        bgImageFileId: string
        bgImageTile: false
        bgType: string
        boxColor: string
        boxLinkColor: string
        boxOpacity: 0
        boxRadius: 0
        boxTextColor: string
        buttonColor: string
        buttonText: string
        buttonTextColor: string
        customized: false
        languages:
            - string
        linkColor: string
        logoFileId: string
        logoPosition: string
        logoSize: 0
        successText: string
        textColor: string
        title: string
        tos: string
        tosEnabled: false
        unsplashAuthorName: string
        unsplashAuthorUsername: string
        welcomeText: string
        welcomeTextEnabled: false
        welcomeTextPosition: string
    portalEnabled: false
    portalHostname: string
    portalUseHostname: false
    quickpay:
        agreementId: string
        apiKey: string
        merchantId: string
        useSandbox: false
    radius:
        authType: string
        disconnectEnabled: false
        disconnectPort: 0
        profileId: string
    redirect:
        toHttps: false
        url: string
        useHttps: false
    restrictedDnsServers:
        - string
    restrictedSubnet: string
    site: string
    stripe:
        apiKey: string
    templateEngine: string
    voucherCustomized: false
    voucherEnabled: false
    wechat:
        appId: string
        appSecret: string
        secretKey: string
        shopId: string

    GuestAccess Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The GuestAccess resource accepts the following input properties:

    AllowedSubnet string
    Subnet allowed for guest access.
    Auth string
    Authentication method for guest access. Valid values are:
    AuthUrl string
    URL for authentication. Must be a valid URL including the protocol.
    Authorize Pulumiverse.Unifi.Setting.Inputs.GuestAccessAuthorize
    Authorize.net payment settings.
    CustomIp string
    Custom IP address. Must be a valid IPv4 address (e.g., 192.168.1.1).
    EcEnabled bool
    Enable enterprise controller functionality.
    Expire int
    Expiration time for guest access.
    ExpireNumber int
    Number value for the expiration time.
    ExpireUnit int
    Unit for the expiration time. Valid values are:

    • 1 - Minute
    • 60 - Hour
    • 1440 - Day
    • 10080 - Week
    Facebook Pulumiverse.Unifi.Setting.Inputs.GuestAccessFacebook
    Facebook authentication settings.
    FacebookWifi Pulumiverse.Unifi.Setting.Inputs.GuestAccessFacebookWifi
    • Facebook auth entication
    Google Pulumiverse.Unifi.Setting.Inputs.GuestAccessGoogle
    Google authentication settings.
    Ippay Pulumiverse.Unifi.Setting.Inputs.GuestAccessIppay
    IPpay Payments settings.
    MerchantWarrior Pulumiverse.Unifi.Setting.Inputs.GuestAccessMerchantWarrior
    MerchantWarrior payment settings.
    Password string
    Password for guest access.
    PaymentGateway string
    Payment gateway. Valid values are:

    • paypal - PayPal
    • stripe - Stripe
    • authorize - Authorize.net
    • quickpay - QuickPay
    • merchantwarrior - Merchant Warrior
    • ippay - IP Payments
    Paypal Pulumiverse.Unifi.Setting.Inputs.GuestAccessPaypal
    PayPal payment settings.
    PortalCustomization Pulumiverse.Unifi.Setting.Inputs.GuestAccessPortalCustomization
    Portal customization settings.
    PortalEnabled bool
    Enable the guest portal.
    PortalHostname string
    Hostname to use for the captive portal.
    PortalUseHostname bool
    Use a custom hostname for the portal.
    Quickpay Pulumiverse.Unifi.Setting.Inputs.GuestAccessQuickpay
    QuickPay payment settings.
    Radius Pulumiverse.Unifi.Setting.Inputs.GuestAccessRadius
    RADIUS authentication settings.
    Redirect Pulumiverse.Unifi.Setting.Inputs.GuestAccessRedirect
    Redirect after authentication settings.
    RestrictedDnsServers List<string>
    List of restricted DNS servers for guest networks. Each value must be a valid IPv4 address.
    RestrictedSubnet string
    Subnet for restricted guest access.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    Stripe Pulumiverse.Unifi.Setting.Inputs.GuestAccessStripe
    Stripe payment settings.
    TemplateEngine string
    Template engine for the portal. Valid values are: jsp, angular.
    VoucherCustomized bool
    Whether vouchers are customized.
    VoucherEnabled bool
    Enable voucher-based authentication for guest access.
    Wechat Pulumiverse.Unifi.Setting.Inputs.GuestAccessWechat
    WeChat authentication settings.
    AllowedSubnet string
    Subnet allowed for guest access.
    Auth string
    Authentication method for guest access. Valid values are:
    AuthUrl string
    URL for authentication. Must be a valid URL including the protocol.
    Authorize GuestAccessAuthorizeArgs
    Authorize.net payment settings.
    CustomIp string
    Custom IP address. Must be a valid IPv4 address (e.g., 192.168.1.1).
    EcEnabled bool
    Enable enterprise controller functionality.
    Expire int
    Expiration time for guest access.
    ExpireNumber int
    Number value for the expiration time.
    ExpireUnit int
    Unit for the expiration time. Valid values are:

    • 1 - Minute
    • 60 - Hour
    • 1440 - Day
    • 10080 - Week
    Facebook GuestAccessFacebookArgs
    Facebook authentication settings.
    FacebookWifi GuestAccessFacebookWifiArgs
    • Facebook auth entication
    Google GuestAccessGoogleArgs
    Google authentication settings.
    Ippay GuestAccessIppayArgs
    IPpay Payments settings.
    MerchantWarrior GuestAccessMerchantWarriorArgs
    MerchantWarrior payment settings.
    Password string
    Password for guest access.
    PaymentGateway string
    Payment gateway. Valid values are:

    • paypal - PayPal
    • stripe - Stripe
    • authorize - Authorize.net
    • quickpay - QuickPay
    • merchantwarrior - Merchant Warrior
    • ippay - IP Payments
    Paypal GuestAccessPaypalArgs
    PayPal payment settings.
    PortalCustomization GuestAccessPortalCustomizationArgs
    Portal customization settings.
    PortalEnabled bool
    Enable the guest portal.
    PortalHostname string
    Hostname to use for the captive portal.
    PortalUseHostname bool
    Use a custom hostname for the portal.
    Quickpay GuestAccessQuickpayArgs
    QuickPay payment settings.
    Radius GuestAccessRadiusArgs
    RADIUS authentication settings.
    Redirect GuestAccessRedirectArgs
    Redirect after authentication settings.
    RestrictedDnsServers []string
    List of restricted DNS servers for guest networks. Each value must be a valid IPv4 address.
    RestrictedSubnet string
    Subnet for restricted guest access.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    Stripe GuestAccessStripeArgs
    Stripe payment settings.
    TemplateEngine string
    Template engine for the portal. Valid values are: jsp, angular.
    VoucherCustomized bool
    Whether vouchers are customized.
    VoucherEnabled bool
    Enable voucher-based authentication for guest access.
    Wechat GuestAccessWechatArgs
    WeChat authentication settings.
    allowedSubnet String
    Subnet allowed for guest access.
    auth String
    Authentication method for guest access. Valid values are:
    authUrl String
    URL for authentication. Must be a valid URL including the protocol.
    authorize GuestAccessAuthorize
    Authorize.net payment settings.
    customIp String
    Custom IP address. Must be a valid IPv4 address (e.g., 192.168.1.1).
    ecEnabled Boolean
    Enable enterprise controller functionality.
    expire Integer
    Expiration time for guest access.
    expireNumber Integer
    Number value for the expiration time.
    expireUnit Integer
    Unit for the expiration time. Valid values are:

    • 1 - Minute
    • 60 - Hour
    • 1440 - Day
    • 10080 - Week
    facebook GuestAccessFacebook
    Facebook authentication settings.
    facebookWifi GuestAccessFacebookWifi
    • Facebook auth entication
    google GuestAccessGoogle
    Google authentication settings.
    ippay GuestAccessIppay
    IPpay Payments settings.
    merchantWarrior GuestAccessMerchantWarrior
    MerchantWarrior payment settings.
    password String
    Password for guest access.
    paymentGateway String
    Payment gateway. Valid values are:

    • paypal - PayPal
    • stripe - Stripe
    • authorize - Authorize.net
    • quickpay - QuickPay
    • merchantwarrior - Merchant Warrior
    • ippay - IP Payments
    paypal GuestAccessPaypal
    PayPal payment settings.
    portalCustomization GuestAccessPortalCustomization
    Portal customization settings.
    portalEnabled Boolean
    Enable the guest portal.
    portalHostname String
    Hostname to use for the captive portal.
    portalUseHostname Boolean
    Use a custom hostname for the portal.
    quickpay GuestAccessQuickpay
    QuickPay payment settings.
    radius GuestAccessRadius
    RADIUS authentication settings.
    redirect GuestAccessRedirect
    Redirect after authentication settings.
    restrictedDnsServers List<String>
    List of restricted DNS servers for guest networks. Each value must be a valid IPv4 address.
    restrictedSubnet String
    Subnet for restricted guest access.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    stripe GuestAccessStripe
    Stripe payment settings.
    templateEngine String
    Template engine for the portal. Valid values are: jsp, angular.
    voucherCustomized Boolean
    Whether vouchers are customized.
    voucherEnabled Boolean
    Enable voucher-based authentication for guest access.
    wechat GuestAccessWechat
    WeChat authentication settings.
    allowedSubnet string
    Subnet allowed for guest access.
    auth string
    Authentication method for guest access. Valid values are:
    authUrl string
    URL for authentication. Must be a valid URL including the protocol.
    authorize GuestAccessAuthorize
    Authorize.net payment settings.
    customIp string
    Custom IP address. Must be a valid IPv4 address (e.g., 192.168.1.1).
    ecEnabled boolean
    Enable enterprise controller functionality.
    expire number
    Expiration time for guest access.
    expireNumber number
    Number value for the expiration time.
    expireUnit number
    Unit for the expiration time. Valid values are:

    • 1 - Minute
    • 60 - Hour
    • 1440 - Day
    • 10080 - Week
    facebook GuestAccessFacebook
    Facebook authentication settings.
    facebookWifi GuestAccessFacebookWifi
    • Facebook auth entication
    google GuestAccessGoogle
    Google authentication settings.
    ippay GuestAccessIppay
    IPpay Payments settings.
    merchantWarrior GuestAccessMerchantWarrior
    MerchantWarrior payment settings.
    password string
    Password for guest access.
    paymentGateway string
    Payment gateway. Valid values are:

    • paypal - PayPal
    • stripe - Stripe
    • authorize - Authorize.net
    • quickpay - QuickPay
    • merchantwarrior - Merchant Warrior
    • ippay - IP Payments
    paypal GuestAccessPaypal
    PayPal payment settings.
    portalCustomization GuestAccessPortalCustomization
    Portal customization settings.
    portalEnabled boolean
    Enable the guest portal.
    portalHostname string
    Hostname to use for the captive portal.
    portalUseHostname boolean
    Use a custom hostname for the portal.
    quickpay GuestAccessQuickpay
    QuickPay payment settings.
    radius GuestAccessRadius
    RADIUS authentication settings.
    redirect GuestAccessRedirect
    Redirect after authentication settings.
    restrictedDnsServers string[]
    List of restricted DNS servers for guest networks. Each value must be a valid IPv4 address.
    restrictedSubnet string
    Subnet for restricted guest access.
    site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    stripe GuestAccessStripe
    Stripe payment settings.
    templateEngine string
    Template engine for the portal. Valid values are: jsp, angular.
    voucherCustomized boolean
    Whether vouchers are customized.
    voucherEnabled boolean
    Enable voucher-based authentication for guest access.
    wechat GuestAccessWechat
    WeChat authentication settings.
    allowed_subnet str
    Subnet allowed for guest access.
    auth str
    Authentication method for guest access. Valid values are:
    auth_url str
    URL for authentication. Must be a valid URL including the protocol.
    authorize GuestAccessAuthorizeArgs
    Authorize.net payment settings.
    custom_ip str
    Custom IP address. Must be a valid IPv4 address (e.g., 192.168.1.1).
    ec_enabled bool
    Enable enterprise controller functionality.
    expire int
    Expiration time for guest access.
    expire_number int
    Number value for the expiration time.
    expire_unit int
    Unit for the expiration time. Valid values are:

    • 1 - Minute
    • 60 - Hour
    • 1440 - Day
    • 10080 - Week
    facebook GuestAccessFacebookArgs
    Facebook authentication settings.
    facebook_wifi GuestAccessFacebookWifiArgs
    • Facebook auth entication
    google GuestAccessGoogleArgs
    Google authentication settings.
    ippay GuestAccessIppayArgs
    IPpay Payments settings.
    merchant_warrior GuestAccessMerchantWarriorArgs
    MerchantWarrior payment settings.
    password str
    Password for guest access.
    payment_gateway str
    Payment gateway. Valid values are:

    • paypal - PayPal
    • stripe - Stripe
    • authorize - Authorize.net
    • quickpay - QuickPay
    • merchantwarrior - Merchant Warrior
    • ippay - IP Payments
    paypal GuestAccessPaypalArgs
    PayPal payment settings.
    portal_customization GuestAccessPortalCustomizationArgs
    Portal customization settings.
    portal_enabled bool
    Enable the guest portal.
    portal_hostname str
    Hostname to use for the captive portal.
    portal_use_hostname bool
    Use a custom hostname for the portal.
    quickpay GuestAccessQuickpayArgs
    QuickPay payment settings.
    radius GuestAccessRadiusArgs
    RADIUS authentication settings.
    redirect GuestAccessRedirectArgs
    Redirect after authentication settings.
    restricted_dns_servers Sequence[str]
    List of restricted DNS servers for guest networks. Each value must be a valid IPv4 address.
    restricted_subnet str
    Subnet for restricted guest access.
    site str
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    stripe GuestAccessStripeArgs
    Stripe payment settings.
    template_engine str
    Template engine for the portal. Valid values are: jsp, angular.
    voucher_customized bool
    Whether vouchers are customized.
    voucher_enabled bool
    Enable voucher-based authentication for guest access.
    wechat GuestAccessWechatArgs
    WeChat authentication settings.
    allowedSubnet String
    Subnet allowed for guest access.
    auth String
    Authentication method for guest access. Valid values are:
    authUrl String
    URL for authentication. Must be a valid URL including the protocol.
    authorize Property Map
    Authorize.net payment settings.
    customIp String
    Custom IP address. Must be a valid IPv4 address (e.g., 192.168.1.1).
    ecEnabled Boolean
    Enable enterprise controller functionality.
    expire Number
    Expiration time for guest access.
    expireNumber Number
    Number value for the expiration time.
    expireUnit Number
    Unit for the expiration time. Valid values are:

    • 1 - Minute
    • 60 - Hour
    • 1440 - Day
    • 10080 - Week
    facebook Property Map
    Facebook authentication settings.
    facebookWifi Property Map
    • Facebook auth entication
    google Property Map
    Google authentication settings.
    ippay Property Map
    IPpay Payments settings.
    merchantWarrior Property Map
    MerchantWarrior payment settings.
    password String
    Password for guest access.
    paymentGateway String
    Payment gateway. Valid values are:

    • paypal - PayPal
    • stripe - Stripe
    • authorize - Authorize.net
    • quickpay - QuickPay
    • merchantwarrior - Merchant Warrior
    • ippay - IP Payments
    paypal Property Map
    PayPal payment settings.
    portalCustomization Property Map
    Portal customization settings.
    portalEnabled Boolean
    Enable the guest portal.
    portalHostname String
    Hostname to use for the captive portal.
    portalUseHostname Boolean
    Use a custom hostname for the portal.
    quickpay Property Map
    QuickPay payment settings.
    radius Property Map
    RADIUS authentication settings.
    redirect Property Map
    Redirect after authentication settings.
    restrictedDnsServers List<String>
    List of restricted DNS servers for guest networks. Each value must be a valid IPv4 address.
    restrictedSubnet String
    Subnet for restricted guest access.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    stripe Property Map
    Stripe payment settings.
    templateEngine String
    Template engine for the portal. Valid values are: jsp, angular.
    voucherCustomized Boolean
    Whether vouchers are customized.
    voucherEnabled Boolean
    Enable voucher-based authentication for guest access.
    wechat Property Map
    WeChat authentication settings.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GuestAccess resource produces the following output properties:

    FacebookEnabled bool
    Whether Facebook authentication for guest access is enabled.
    GoogleEnabled bool
    Whether Google authentication for guest access is enabled.
    Id string
    The provider-assigned unique ID for this managed resource.
    PasswordEnabled bool
    Enable password authentication for guest access.
    PaymentEnabled bool
    Enable payment for guest access.
    RadiusEnabled bool
    Whether RADIUS authentication for guest access is enabled.
    RedirectEnabled bool
    Whether redirect after authentication is enabled.
    RestrictedDnsEnabled bool
    Whether restricted DNS servers for guest networks are enabled.
    WechatEnabled bool
    Whether WeChat authentication for guest access is enabled.
    FacebookEnabled bool
    Whether Facebook authentication for guest access is enabled.
    GoogleEnabled bool
    Whether Google authentication for guest access is enabled.
    Id string
    The provider-assigned unique ID for this managed resource.
    PasswordEnabled bool
    Enable password authentication for guest access.
    PaymentEnabled bool
    Enable payment for guest access.
    RadiusEnabled bool
    Whether RADIUS authentication for guest access is enabled.
    RedirectEnabled bool
    Whether redirect after authentication is enabled.
    RestrictedDnsEnabled bool
    Whether restricted DNS servers for guest networks are enabled.
    WechatEnabled bool
    Whether WeChat authentication for guest access is enabled.
    facebookEnabled Boolean
    Whether Facebook authentication for guest access is enabled.
    googleEnabled Boolean
    Whether Google authentication for guest access is enabled.
    id String
    The provider-assigned unique ID for this managed resource.
    passwordEnabled Boolean
    Enable password authentication for guest access.
    paymentEnabled Boolean
    Enable payment for guest access.
    radiusEnabled Boolean
    Whether RADIUS authentication for guest access is enabled.
    redirectEnabled Boolean
    Whether redirect after authentication is enabled.
    restrictedDnsEnabled Boolean
    Whether restricted DNS servers for guest networks are enabled.
    wechatEnabled Boolean
    Whether WeChat authentication for guest access is enabled.
    facebookEnabled boolean
    Whether Facebook authentication for guest access is enabled.
    googleEnabled boolean
    Whether Google authentication for guest access is enabled.
    id string
    The provider-assigned unique ID for this managed resource.
    passwordEnabled boolean
    Enable password authentication for guest access.
    paymentEnabled boolean
    Enable payment for guest access.
    radiusEnabled boolean
    Whether RADIUS authentication for guest access is enabled.
    redirectEnabled boolean
    Whether redirect after authentication is enabled.
    restrictedDnsEnabled boolean
    Whether restricted DNS servers for guest networks are enabled.
    wechatEnabled boolean
    Whether WeChat authentication for guest access is enabled.
    facebook_enabled bool
    Whether Facebook authentication for guest access is enabled.
    google_enabled bool
    Whether Google authentication for guest access is enabled.
    id str
    The provider-assigned unique ID for this managed resource.
    password_enabled bool
    Enable password authentication for guest access.
    payment_enabled bool
    Enable payment for guest access.
    radius_enabled bool
    Whether RADIUS authentication for guest access is enabled.
    redirect_enabled bool
    Whether redirect after authentication is enabled.
    restricted_dns_enabled bool
    Whether restricted DNS servers for guest networks are enabled.
    wechat_enabled bool
    Whether WeChat authentication for guest access is enabled.
    facebookEnabled Boolean
    Whether Facebook authentication for guest access is enabled.
    googleEnabled Boolean
    Whether Google authentication for guest access is enabled.
    id String
    The provider-assigned unique ID for this managed resource.
    passwordEnabled Boolean
    Enable password authentication for guest access.
    paymentEnabled Boolean
    Enable payment for guest access.
    radiusEnabled Boolean
    Whether RADIUS authentication for guest access is enabled.
    redirectEnabled Boolean
    Whether redirect after authentication is enabled.
    restrictedDnsEnabled Boolean
    Whether restricted DNS servers for guest networks are enabled.
    wechatEnabled Boolean
    Whether WeChat authentication for guest access is enabled.

    Look up Existing GuestAccess Resource

    Get an existing GuestAccess resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GuestAccessState, opts?: CustomResourceOptions): GuestAccess
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowed_subnet: Optional[str] = None,
        auth: Optional[str] = None,
        auth_url: Optional[str] = None,
        authorize: Optional[GuestAccessAuthorizeArgs] = None,
        custom_ip: Optional[str] = None,
        ec_enabled: Optional[bool] = None,
        expire: Optional[int] = None,
        expire_number: Optional[int] = None,
        expire_unit: Optional[int] = None,
        facebook: Optional[GuestAccessFacebookArgs] = None,
        facebook_enabled: Optional[bool] = None,
        facebook_wifi: Optional[GuestAccessFacebookWifiArgs] = None,
        google: Optional[GuestAccessGoogleArgs] = None,
        google_enabled: Optional[bool] = None,
        ippay: Optional[GuestAccessIppayArgs] = None,
        merchant_warrior: Optional[GuestAccessMerchantWarriorArgs] = None,
        password: Optional[str] = None,
        password_enabled: Optional[bool] = None,
        payment_enabled: Optional[bool] = None,
        payment_gateway: Optional[str] = None,
        paypal: Optional[GuestAccessPaypalArgs] = None,
        portal_customization: Optional[GuestAccessPortalCustomizationArgs] = None,
        portal_enabled: Optional[bool] = None,
        portal_hostname: Optional[str] = None,
        portal_use_hostname: Optional[bool] = None,
        quickpay: Optional[GuestAccessQuickpayArgs] = None,
        radius: Optional[GuestAccessRadiusArgs] = None,
        radius_enabled: Optional[bool] = None,
        redirect: Optional[GuestAccessRedirectArgs] = None,
        redirect_enabled: Optional[bool] = None,
        restricted_dns_enabled: Optional[bool] = None,
        restricted_dns_servers: Optional[Sequence[str]] = None,
        restricted_subnet: Optional[str] = None,
        site: Optional[str] = None,
        stripe: Optional[GuestAccessStripeArgs] = None,
        template_engine: Optional[str] = None,
        voucher_customized: Optional[bool] = None,
        voucher_enabled: Optional[bool] = None,
        wechat: Optional[GuestAccessWechatArgs] = None,
        wechat_enabled: Optional[bool] = None) -> GuestAccess
    func GetGuestAccess(ctx *Context, name string, id IDInput, state *GuestAccessState, opts ...ResourceOption) (*GuestAccess, error)
    public static GuestAccess Get(string name, Input<string> id, GuestAccessState? state, CustomResourceOptions? opts = null)
    public static GuestAccess get(String name, Output<String> id, GuestAccessState state, CustomResourceOptions options)
    resources:  _:    type: unifi:setting:GuestAccess    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllowedSubnet string
    Subnet allowed for guest access.
    Auth string
    Authentication method for guest access. Valid values are:
    AuthUrl string
    URL for authentication. Must be a valid URL including the protocol.
    Authorize Pulumiverse.Unifi.Setting.Inputs.GuestAccessAuthorize
    Authorize.net payment settings.
    CustomIp string
    Custom IP address. Must be a valid IPv4 address (e.g., 192.168.1.1).
    EcEnabled bool
    Enable enterprise controller functionality.
    Expire int
    Expiration time for guest access.
    ExpireNumber int
    Number value for the expiration time.
    ExpireUnit int
    Unit for the expiration time. Valid values are:

    • 1 - Minute
    • 60 - Hour
    • 1440 - Day
    • 10080 - Week
    Facebook Pulumiverse.Unifi.Setting.Inputs.GuestAccessFacebook
    Facebook authentication settings.
    FacebookEnabled bool
    Whether Facebook authentication for guest access is enabled.
    FacebookWifi Pulumiverse.Unifi.Setting.Inputs.GuestAccessFacebookWifi
    • Facebook auth entication
    Google Pulumiverse.Unifi.Setting.Inputs.GuestAccessGoogle
    Google authentication settings.
    GoogleEnabled bool
    Whether Google authentication for guest access is enabled.
    Ippay Pulumiverse.Unifi.Setting.Inputs.GuestAccessIppay
    IPpay Payments settings.
    MerchantWarrior Pulumiverse.Unifi.Setting.Inputs.GuestAccessMerchantWarrior
    MerchantWarrior payment settings.
    Password string
    Password for guest access.
    PasswordEnabled bool
    Enable password authentication for guest access.
    PaymentEnabled bool
    Enable payment for guest access.
    PaymentGateway string
    Payment gateway. Valid values are:

    • paypal - PayPal
    • stripe - Stripe
    • authorize - Authorize.net
    • quickpay - QuickPay
    • merchantwarrior - Merchant Warrior
    • ippay - IP Payments
    Paypal Pulumiverse.Unifi.Setting.Inputs.GuestAccessPaypal
    PayPal payment settings.
    PortalCustomization Pulumiverse.Unifi.Setting.Inputs.GuestAccessPortalCustomization
    Portal customization settings.
    PortalEnabled bool
    Enable the guest portal.
    PortalHostname string
    Hostname to use for the captive portal.
    PortalUseHostname bool
    Use a custom hostname for the portal.
    Quickpay Pulumiverse.Unifi.Setting.Inputs.GuestAccessQuickpay
    QuickPay payment settings.
    Radius Pulumiverse.Unifi.Setting.Inputs.GuestAccessRadius
    RADIUS authentication settings.
    RadiusEnabled bool
    Whether RADIUS authentication for guest access is enabled.
    Redirect Pulumiverse.Unifi.Setting.Inputs.GuestAccessRedirect
    Redirect after authentication settings.
    RedirectEnabled bool
    Whether redirect after authentication is enabled.
    RestrictedDnsEnabled bool
    Whether restricted DNS servers for guest networks are enabled.
    RestrictedDnsServers List<string>
    List of restricted DNS servers for guest networks. Each value must be a valid IPv4 address.
    RestrictedSubnet string
    Subnet for restricted guest access.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    Stripe Pulumiverse.Unifi.Setting.Inputs.GuestAccessStripe
    Stripe payment settings.
    TemplateEngine string
    Template engine for the portal. Valid values are: jsp, angular.
    VoucherCustomized bool
    Whether vouchers are customized.
    VoucherEnabled bool
    Enable voucher-based authentication for guest access.
    Wechat Pulumiverse.Unifi.Setting.Inputs.GuestAccessWechat
    WeChat authentication settings.
    WechatEnabled bool
    Whether WeChat authentication for guest access is enabled.
    AllowedSubnet string
    Subnet allowed for guest access.
    Auth string
    Authentication method for guest access. Valid values are:
    AuthUrl string
    URL for authentication. Must be a valid URL including the protocol.
    Authorize GuestAccessAuthorizeArgs
    Authorize.net payment settings.
    CustomIp string
    Custom IP address. Must be a valid IPv4 address (e.g., 192.168.1.1).
    EcEnabled bool
    Enable enterprise controller functionality.
    Expire int
    Expiration time for guest access.
    ExpireNumber int
    Number value for the expiration time.
    ExpireUnit int
    Unit for the expiration time. Valid values are:

    • 1 - Minute
    • 60 - Hour
    • 1440 - Day
    • 10080 - Week
    Facebook GuestAccessFacebookArgs
    Facebook authentication settings.
    FacebookEnabled bool
    Whether Facebook authentication for guest access is enabled.
    FacebookWifi GuestAccessFacebookWifiArgs
    • Facebook auth entication
    Google GuestAccessGoogleArgs
    Google authentication settings.
    GoogleEnabled bool
    Whether Google authentication for guest access is enabled.
    Ippay GuestAccessIppayArgs
    IPpay Payments settings.
    MerchantWarrior GuestAccessMerchantWarriorArgs
    MerchantWarrior payment settings.
    Password string
    Password for guest access.
    PasswordEnabled bool
    Enable password authentication for guest access.
    PaymentEnabled bool
    Enable payment for guest access.
    PaymentGateway string
    Payment gateway. Valid values are:

    • paypal - PayPal
    • stripe - Stripe
    • authorize - Authorize.net
    • quickpay - QuickPay
    • merchantwarrior - Merchant Warrior
    • ippay - IP Payments
    Paypal GuestAccessPaypalArgs
    PayPal payment settings.
    PortalCustomization GuestAccessPortalCustomizationArgs
    Portal customization settings.
    PortalEnabled bool
    Enable the guest portal.
    PortalHostname string
    Hostname to use for the captive portal.
    PortalUseHostname bool
    Use a custom hostname for the portal.
    Quickpay GuestAccessQuickpayArgs
    QuickPay payment settings.
    Radius GuestAccessRadiusArgs
    RADIUS authentication settings.
    RadiusEnabled bool
    Whether RADIUS authentication for guest access is enabled.
    Redirect GuestAccessRedirectArgs
    Redirect after authentication settings.
    RedirectEnabled bool
    Whether redirect after authentication is enabled.
    RestrictedDnsEnabled bool
    Whether restricted DNS servers for guest networks are enabled.
    RestrictedDnsServers []string
    List of restricted DNS servers for guest networks. Each value must be a valid IPv4 address.
    RestrictedSubnet string
    Subnet for restricted guest access.
    Site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    Stripe GuestAccessStripeArgs
    Stripe payment settings.
    TemplateEngine string
    Template engine for the portal. Valid values are: jsp, angular.
    VoucherCustomized bool
    Whether vouchers are customized.
    VoucherEnabled bool
    Enable voucher-based authentication for guest access.
    Wechat GuestAccessWechatArgs
    WeChat authentication settings.
    WechatEnabled bool
    Whether WeChat authentication for guest access is enabled.
    allowedSubnet String
    Subnet allowed for guest access.
    auth String
    Authentication method for guest access. Valid values are:
    authUrl String
    URL for authentication. Must be a valid URL including the protocol.
    authorize GuestAccessAuthorize
    Authorize.net payment settings.
    customIp String
    Custom IP address. Must be a valid IPv4 address (e.g., 192.168.1.1).
    ecEnabled Boolean
    Enable enterprise controller functionality.
    expire Integer
    Expiration time for guest access.
    expireNumber Integer
    Number value for the expiration time.
    expireUnit Integer
    Unit for the expiration time. Valid values are:

    • 1 - Minute
    • 60 - Hour
    • 1440 - Day
    • 10080 - Week
    facebook GuestAccessFacebook
    Facebook authentication settings.
    facebookEnabled Boolean
    Whether Facebook authentication for guest access is enabled.
    facebookWifi GuestAccessFacebookWifi
    • Facebook auth entication
    google GuestAccessGoogle
    Google authentication settings.
    googleEnabled Boolean
    Whether Google authentication for guest access is enabled.
    ippay GuestAccessIppay
    IPpay Payments settings.
    merchantWarrior GuestAccessMerchantWarrior
    MerchantWarrior payment settings.
    password String
    Password for guest access.
    passwordEnabled Boolean
    Enable password authentication for guest access.
    paymentEnabled Boolean
    Enable payment for guest access.
    paymentGateway String
    Payment gateway. Valid values are:

    • paypal - PayPal
    • stripe - Stripe
    • authorize - Authorize.net
    • quickpay - QuickPay
    • merchantwarrior - Merchant Warrior
    • ippay - IP Payments
    paypal GuestAccessPaypal
    PayPal payment settings.
    portalCustomization GuestAccessPortalCustomization
    Portal customization settings.
    portalEnabled Boolean
    Enable the guest portal.
    portalHostname String
    Hostname to use for the captive portal.
    portalUseHostname Boolean
    Use a custom hostname for the portal.
    quickpay GuestAccessQuickpay
    QuickPay payment settings.
    radius GuestAccessRadius
    RADIUS authentication settings.
    radiusEnabled Boolean
    Whether RADIUS authentication for guest access is enabled.
    redirect GuestAccessRedirect
    Redirect after authentication settings.
    redirectEnabled Boolean
    Whether redirect after authentication is enabled.
    restrictedDnsEnabled Boolean
    Whether restricted DNS servers for guest networks are enabled.
    restrictedDnsServers List<String>
    List of restricted DNS servers for guest networks. Each value must be a valid IPv4 address.
    restrictedSubnet String
    Subnet for restricted guest access.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    stripe GuestAccessStripe
    Stripe payment settings.
    templateEngine String
    Template engine for the portal. Valid values are: jsp, angular.
    voucherCustomized Boolean
    Whether vouchers are customized.
    voucherEnabled Boolean
    Enable voucher-based authentication for guest access.
    wechat GuestAccessWechat
    WeChat authentication settings.
    wechatEnabled Boolean
    Whether WeChat authentication for guest access is enabled.
    allowedSubnet string
    Subnet allowed for guest access.
    auth string
    Authentication method for guest access. Valid values are:
    authUrl string
    URL for authentication. Must be a valid URL including the protocol.
    authorize GuestAccessAuthorize
    Authorize.net payment settings.
    customIp string
    Custom IP address. Must be a valid IPv4 address (e.g., 192.168.1.1).
    ecEnabled boolean
    Enable enterprise controller functionality.
    expire number
    Expiration time for guest access.
    expireNumber number
    Number value for the expiration time.
    expireUnit number
    Unit for the expiration time. Valid values are:

    • 1 - Minute
    • 60 - Hour
    • 1440 - Day
    • 10080 - Week
    facebook GuestAccessFacebook
    Facebook authentication settings.
    facebookEnabled boolean
    Whether Facebook authentication for guest access is enabled.
    facebookWifi GuestAccessFacebookWifi
    • Facebook auth entication
    google GuestAccessGoogle
    Google authentication settings.
    googleEnabled boolean
    Whether Google authentication for guest access is enabled.
    ippay GuestAccessIppay
    IPpay Payments settings.
    merchantWarrior GuestAccessMerchantWarrior
    MerchantWarrior payment settings.
    password string
    Password for guest access.
    passwordEnabled boolean
    Enable password authentication for guest access.
    paymentEnabled boolean
    Enable payment for guest access.
    paymentGateway string
    Payment gateway. Valid values are:

    • paypal - PayPal
    • stripe - Stripe
    • authorize - Authorize.net
    • quickpay - QuickPay
    • merchantwarrior - Merchant Warrior
    • ippay - IP Payments
    paypal GuestAccessPaypal
    PayPal payment settings.
    portalCustomization GuestAccessPortalCustomization
    Portal customization settings.
    portalEnabled boolean
    Enable the guest portal.
    portalHostname string
    Hostname to use for the captive portal.
    portalUseHostname boolean
    Use a custom hostname for the portal.
    quickpay GuestAccessQuickpay
    QuickPay payment settings.
    radius GuestAccessRadius
    RADIUS authentication settings.
    radiusEnabled boolean
    Whether RADIUS authentication for guest access is enabled.
    redirect GuestAccessRedirect
    Redirect after authentication settings.
    redirectEnabled boolean
    Whether redirect after authentication is enabled.
    restrictedDnsEnabled boolean
    Whether restricted DNS servers for guest networks are enabled.
    restrictedDnsServers string[]
    List of restricted DNS servers for guest networks. Each value must be a valid IPv4 address.
    restrictedSubnet string
    Subnet for restricted guest access.
    site string
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    stripe GuestAccessStripe
    Stripe payment settings.
    templateEngine string
    Template engine for the portal. Valid values are: jsp, angular.
    voucherCustomized boolean
    Whether vouchers are customized.
    voucherEnabled boolean
    Enable voucher-based authentication for guest access.
    wechat GuestAccessWechat
    WeChat authentication settings.
    wechatEnabled boolean
    Whether WeChat authentication for guest access is enabled.
    allowed_subnet str
    Subnet allowed for guest access.
    auth str
    Authentication method for guest access. Valid values are:
    auth_url str
    URL for authentication. Must be a valid URL including the protocol.
    authorize GuestAccessAuthorizeArgs
    Authorize.net payment settings.
    custom_ip str
    Custom IP address. Must be a valid IPv4 address (e.g., 192.168.1.1).
    ec_enabled bool
    Enable enterprise controller functionality.
    expire int
    Expiration time for guest access.
    expire_number int
    Number value for the expiration time.
    expire_unit int
    Unit for the expiration time. Valid values are:

    • 1 - Minute
    • 60 - Hour
    • 1440 - Day
    • 10080 - Week
    facebook GuestAccessFacebookArgs
    Facebook authentication settings.
    facebook_enabled bool
    Whether Facebook authentication for guest access is enabled.
    facebook_wifi GuestAccessFacebookWifiArgs
    • Facebook auth entication
    google GuestAccessGoogleArgs
    Google authentication settings.
    google_enabled bool
    Whether Google authentication for guest access is enabled.
    ippay GuestAccessIppayArgs
    IPpay Payments settings.
    merchant_warrior GuestAccessMerchantWarriorArgs
    MerchantWarrior payment settings.
    password str
    Password for guest access.
    password_enabled bool
    Enable password authentication for guest access.
    payment_enabled bool
    Enable payment for guest access.
    payment_gateway str
    Payment gateway. Valid values are:

    • paypal - PayPal
    • stripe - Stripe
    • authorize - Authorize.net
    • quickpay - QuickPay
    • merchantwarrior - Merchant Warrior
    • ippay - IP Payments
    paypal GuestAccessPaypalArgs
    PayPal payment settings.
    portal_customization GuestAccessPortalCustomizationArgs
    Portal customization settings.
    portal_enabled bool
    Enable the guest portal.
    portal_hostname str
    Hostname to use for the captive portal.
    portal_use_hostname bool
    Use a custom hostname for the portal.
    quickpay GuestAccessQuickpayArgs
    QuickPay payment settings.
    radius GuestAccessRadiusArgs
    RADIUS authentication settings.
    radius_enabled bool
    Whether RADIUS authentication for guest access is enabled.
    redirect GuestAccessRedirectArgs
    Redirect after authentication settings.
    redirect_enabled bool
    Whether redirect after authentication is enabled.
    restricted_dns_enabled bool
    Whether restricted DNS servers for guest networks are enabled.
    restricted_dns_servers Sequence[str]
    List of restricted DNS servers for guest networks. Each value must be a valid IPv4 address.
    restricted_subnet str
    Subnet for restricted guest access.
    site str
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    stripe GuestAccessStripeArgs
    Stripe payment settings.
    template_engine str
    Template engine for the portal. Valid values are: jsp, angular.
    voucher_customized bool
    Whether vouchers are customized.
    voucher_enabled bool
    Enable voucher-based authentication for guest access.
    wechat GuestAccessWechatArgs
    WeChat authentication settings.
    wechat_enabled bool
    Whether WeChat authentication for guest access is enabled.
    allowedSubnet String
    Subnet allowed for guest access.
    auth String
    Authentication method for guest access. Valid values are:
    authUrl String
    URL for authentication. Must be a valid URL including the protocol.
    authorize Property Map
    Authorize.net payment settings.
    customIp String
    Custom IP address. Must be a valid IPv4 address (e.g., 192.168.1.1).
    ecEnabled Boolean
    Enable enterprise controller functionality.
    expire Number
    Expiration time for guest access.
    expireNumber Number
    Number value for the expiration time.
    expireUnit Number
    Unit for the expiration time. Valid values are:

    • 1 - Minute
    • 60 - Hour
    • 1440 - Day
    • 10080 - Week
    facebook Property Map
    Facebook authentication settings.
    facebookEnabled Boolean
    Whether Facebook authentication for guest access is enabled.
    facebookWifi Property Map
    • Facebook auth entication
    google Property Map
    Google authentication settings.
    googleEnabled Boolean
    Whether Google authentication for guest access is enabled.
    ippay Property Map
    IPpay Payments settings.
    merchantWarrior Property Map
    MerchantWarrior payment settings.
    password String
    Password for guest access.
    passwordEnabled Boolean
    Enable password authentication for guest access.
    paymentEnabled Boolean
    Enable payment for guest access.
    paymentGateway String
    Payment gateway. Valid values are:

    • paypal - PayPal
    • stripe - Stripe
    • authorize - Authorize.net
    • quickpay - QuickPay
    • merchantwarrior - Merchant Warrior
    • ippay - IP Payments
    paypal Property Map
    PayPal payment settings.
    portalCustomization Property Map
    Portal customization settings.
    portalEnabled Boolean
    Enable the guest portal.
    portalHostname String
    Hostname to use for the captive portal.
    portalUseHostname Boolean
    Use a custom hostname for the portal.
    quickpay Property Map
    QuickPay payment settings.
    radius Property Map
    RADIUS authentication settings.
    radiusEnabled Boolean
    Whether RADIUS authentication for guest access is enabled.
    redirect Property Map
    Redirect after authentication settings.
    redirectEnabled Boolean
    Whether redirect after authentication is enabled.
    restrictedDnsEnabled Boolean
    Whether restricted DNS servers for guest networks are enabled.
    restrictedDnsServers List<String>
    List of restricted DNS servers for guest networks. Each value must be a valid IPv4 address.
    restrictedSubnet String
    Subnet for restricted guest access.
    site String
    The name of the UniFi site where this resource should be applied. If not specified, the default site will be used.
    stripe Property Map
    Stripe payment settings.
    templateEngine String
    Template engine for the portal. Valid values are: jsp, angular.
    voucherCustomized Boolean
    Whether vouchers are customized.
    voucherEnabled Boolean
    Enable voucher-based authentication for guest access.
    wechat Property Map
    WeChat authentication settings.
    wechatEnabled Boolean
    Whether WeChat authentication for guest access is enabled.

    Supporting Types

    GuestAccessAuthorize, GuestAccessAuthorizeArgs

    LoginId string
    Authorize.net login ID for authentication.
    TransactionKey string
    Authorize.net transaction key for authentication.
    UseSandbox bool
    Use sandbox mode for Authorize.net payments.
    LoginId string
    Authorize.net login ID for authentication.
    TransactionKey string
    Authorize.net transaction key for authentication.
    UseSandbox bool
    Use sandbox mode for Authorize.net payments.
    loginId String
    Authorize.net login ID for authentication.
    transactionKey String
    Authorize.net transaction key for authentication.
    useSandbox Boolean
    Use sandbox mode for Authorize.net payments.
    loginId string
    Authorize.net login ID for authentication.
    transactionKey string
    Authorize.net transaction key for authentication.
    useSandbox boolean
    Use sandbox mode for Authorize.net payments.
    login_id str
    Authorize.net login ID for authentication.
    transaction_key str
    Authorize.net transaction key for authentication.
    use_sandbox bool
    Use sandbox mode for Authorize.net payments.
    loginId String
    Authorize.net login ID for authentication.
    transactionKey String
    Authorize.net transaction key for authentication.
    useSandbox Boolean
    Use sandbox mode for Authorize.net payments.

    GuestAccessFacebook, GuestAccessFacebookArgs

    AppId string
    Facebook application ID for authentication.
    AppSecret string
    Facebook application secret for authentication.
    ScopeEmail bool
    Request email scope for Facebook authentication.
    AppId string
    Facebook application ID for authentication.
    AppSecret string
    Facebook application secret for authentication.
    ScopeEmail bool
    Request email scope for Facebook authentication.
    appId String
    Facebook application ID for authentication.
    appSecret String
    Facebook application secret for authentication.
    scopeEmail Boolean
    Request email scope for Facebook authentication.
    appId string
    Facebook application ID for authentication.
    appSecret string
    Facebook application secret for authentication.
    scopeEmail boolean
    Request email scope for Facebook authentication.
    app_id str
    Facebook application ID for authentication.
    app_secret str
    Facebook application secret for authentication.
    scope_email bool
    Request email scope for Facebook authentication.
    appId String
    Facebook application ID for authentication.
    appSecret String
    Facebook application secret for authentication.
    scopeEmail Boolean
    Request email scope for Facebook authentication.

    GuestAccessFacebookWifi, GuestAccessFacebookWifiArgs

    GatewayId string
    Facebook WiFi gateway ID.
    GatewayName string
    Facebook WiFi gateway name.
    GatewaySecret string
    Facebook WiFi gateway secret.
    BlockHttps bool
    Mode HTTPS for Facebook WiFi.
    GatewayId string
    Facebook WiFi gateway ID.
    GatewayName string
    Facebook WiFi gateway name.
    GatewaySecret string
    Facebook WiFi gateway secret.
    BlockHttps bool
    Mode HTTPS for Facebook WiFi.
    gatewayId String
    Facebook WiFi gateway ID.
    gatewayName String
    Facebook WiFi gateway name.
    gatewaySecret String
    Facebook WiFi gateway secret.
    blockHttps Boolean
    Mode HTTPS for Facebook WiFi.
    gatewayId string
    Facebook WiFi gateway ID.
    gatewayName string
    Facebook WiFi gateway name.
    gatewaySecret string
    Facebook WiFi gateway secret.
    blockHttps boolean
    Mode HTTPS for Facebook WiFi.
    gateway_id str
    Facebook WiFi gateway ID.
    gateway_name str
    Facebook WiFi gateway name.
    gateway_secret str
    Facebook WiFi gateway secret.
    block_https bool
    Mode HTTPS for Facebook WiFi.
    gatewayId String
    Facebook WiFi gateway ID.
    gatewayName String
    Facebook WiFi gateway name.
    gatewaySecret String
    Facebook WiFi gateway secret.
    blockHttps Boolean
    Mode HTTPS for Facebook WiFi.

    GuestAccessGoogle, GuestAccessGoogleArgs

    ClientId string
    Google client ID for authentication.
    ClientSecret string
    Google client secret for authentication.
    Domain string
    Restrict Google authentication to specific domain.
    ScopeEmail bool
    Request email scope for Google authentication.
    ClientId string
    Google client ID for authentication.
    ClientSecret string
    Google client secret for authentication.
    Domain string
    Restrict Google authentication to specific domain.
    ScopeEmail bool
    Request email scope for Google authentication.
    clientId String
    Google client ID for authentication.
    clientSecret String
    Google client secret for authentication.
    domain String
    Restrict Google authentication to specific domain.
    scopeEmail Boolean
    Request email scope for Google authentication.
    clientId string
    Google client ID for authentication.
    clientSecret string
    Google client secret for authentication.
    domain string
    Restrict Google authentication to specific domain.
    scopeEmail boolean
    Request email scope for Google authentication.
    client_id str
    Google client ID for authentication.
    client_secret str
    Google client secret for authentication.
    domain str
    Restrict Google authentication to specific domain.
    scope_email bool
    Request email scope for Google authentication.
    clientId String
    Google client ID for authentication.
    clientSecret String
    Google client secret for authentication.
    domain String
    Restrict Google authentication to specific domain.
    scopeEmail Boolean
    Request email scope for Google authentication.

    GuestAccessIppay, GuestAccessIppayArgs

    TerminalId string
    Terminal ID for IP Payments.
    UseSandbox bool
    Whether to use sandbox mode for IPPay payments.
    TerminalId string
    Terminal ID for IP Payments.
    UseSandbox bool
    Whether to use sandbox mode for IPPay payments.
    terminalId String
    Terminal ID for IP Payments.
    useSandbox Boolean
    Whether to use sandbox mode for IPPay payments.
    terminalId string
    Terminal ID for IP Payments.
    useSandbox boolean
    Whether to use sandbox mode for IPPay payments.
    terminal_id str
    Terminal ID for IP Payments.
    use_sandbox bool
    Whether to use sandbox mode for IPPay payments.
    terminalId String
    Terminal ID for IP Payments.
    useSandbox Boolean
    Whether to use sandbox mode for IPPay payments.

    GuestAccessMerchantWarrior, GuestAccessMerchantWarriorArgs

    ApiKey string
    MerchantWarrior API key.
    ApiPassphrase string
    MerchantWarrior API passphrase.
    MerchantUuid string
    MerchantWarrior merchant UUID.
    UseSandbox bool
    Whether to use sandbox mode for MerchantWarrior payments.
    ApiKey string
    MerchantWarrior API key.
    ApiPassphrase string
    MerchantWarrior API passphrase.
    MerchantUuid string
    MerchantWarrior merchant UUID.
    UseSandbox bool
    Whether to use sandbox mode for MerchantWarrior payments.
    apiKey String
    MerchantWarrior API key.
    apiPassphrase String
    MerchantWarrior API passphrase.
    merchantUuid String
    MerchantWarrior merchant UUID.
    useSandbox Boolean
    Whether to use sandbox mode for MerchantWarrior payments.
    apiKey string
    MerchantWarrior API key.
    apiPassphrase string
    MerchantWarrior API passphrase.
    merchantUuid string
    MerchantWarrior merchant UUID.
    useSandbox boolean
    Whether to use sandbox mode for MerchantWarrior payments.
    api_key str
    MerchantWarrior API key.
    api_passphrase str
    MerchantWarrior API passphrase.
    merchant_uuid str
    MerchantWarrior merchant UUID.
    use_sandbox bool
    Whether to use sandbox mode for MerchantWarrior payments.
    apiKey String
    MerchantWarrior API key.
    apiPassphrase String
    MerchantWarrior API passphrase.
    merchantUuid String
    MerchantWarrior merchant UUID.
    useSandbox Boolean
    Whether to use sandbox mode for MerchantWarrior payments.

    GuestAccessPaypal, GuestAccessPaypalArgs

    Password string
    PayPal password.
    Signature string
    PayPal signature.
    Username string
    PayPal username. Must be a valid email address.
    UseSandbox bool
    Whether to use sandbox mode for PayPal payments.
    Password string
    PayPal password.
    Signature string
    PayPal signature.
    Username string
    PayPal username. Must be a valid email address.
    UseSandbox bool
    Whether to use sandbox mode for PayPal payments.
    password String
    PayPal password.
    signature String
    PayPal signature.
    username String
    PayPal username. Must be a valid email address.
    useSandbox Boolean
    Whether to use sandbox mode for PayPal payments.
    password string
    PayPal password.
    signature string
    PayPal signature.
    username string
    PayPal username. Must be a valid email address.
    useSandbox boolean
    Whether to use sandbox mode for PayPal payments.
    password str
    PayPal password.
    signature str
    PayPal signature.
    username str
    PayPal username. Must be a valid email address.
    use_sandbox bool
    Whether to use sandbox mode for PayPal payments.
    password String
    PayPal password.
    signature String
    PayPal signature.
    username String
    PayPal username. Must be a valid email address.
    useSandbox Boolean
    Whether to use sandbox mode for PayPal payments.

    GuestAccessPortalCustomization, GuestAccessPortalCustomizationArgs

    AuthenticationText string
    Custom authentication text for the portal.
    BgColor string
    Background color for the custom portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    BgImageFileId string
    ID of the background image portal file. File must exist in controller, use unifi.port.AlFile to manage it.
    BgImageTile bool
    Tile the background image.
    BgType string
    Type of portal background. Valid values are:
    BoxColor string
    Color of the login box in the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    BoxLinkColor string
    Color of links in the login box. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    BoxOpacity int
    Opacity of the login box (0-100).
    BoxRadius int
    Border radius of the login box in pixels.
    BoxTextColor string
    Text color in the login box. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    ButtonColor string
    Button color in the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    ButtonText string
    Custom text for the login button.
    ButtonTextColor string
    Button text color. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    Customized bool
    Whether the portal is customized.
    Languages List<string>
    List of enabled languages for the portal.
    LinkColor string
    Color for links in the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    LogoFileId string
    ID of the logo image portal file. File must exist in controller, use unifi.port.AlFile to manage it.
    LogoPosition string
    Position of the logo in the portal. Valid values are: left, center, right.
    LogoSize int
    Size of the logo in pixels.
    SuccessText string
    Text displayed after successful authentication.
    TextColor string
    Main text color for the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    Title string
    Title of the portal page.
    Tos string
    Terms of service text.
    TosEnabled bool
    Enable terms of service acceptance requirement.
    UnsplashAuthorName string
    Name of the Unsplash author for gallery background.
    UnsplashAuthorUsername string
    Username of the Unsplash author for gallery background.
    WelcomeText string
    Welcome text displayed on the portal.
    WelcomeTextEnabled bool
    Enable welcome text display.
    WelcomeTextPosition string
    Position of the welcome text. Valid values are: under_logo, above_boxes.
    AuthenticationText string
    Custom authentication text for the portal.
    BgColor string
    Background color for the custom portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    BgImageFileId string
    ID of the background image portal file. File must exist in controller, use unifi.port.AlFile to manage it.
    BgImageTile bool
    Tile the background image.
    BgType string
    Type of portal background. Valid values are:
    BoxColor string
    Color of the login box in the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    BoxLinkColor string
    Color of links in the login box. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    BoxOpacity int
    Opacity of the login box (0-100).
    BoxRadius int
    Border radius of the login box in pixels.
    BoxTextColor string
    Text color in the login box. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    ButtonColor string
    Button color in the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    ButtonText string
    Custom text for the login button.
    ButtonTextColor string
    Button text color. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    Customized bool
    Whether the portal is customized.
    Languages []string
    List of enabled languages for the portal.
    LinkColor string
    Color for links in the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    LogoFileId string
    ID of the logo image portal file. File must exist in controller, use unifi.port.AlFile to manage it.
    LogoPosition string
    Position of the logo in the portal. Valid values are: left, center, right.
    LogoSize int
    Size of the logo in pixels.
    SuccessText string
    Text displayed after successful authentication.
    TextColor string
    Main text color for the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    Title string
    Title of the portal page.
    Tos string
    Terms of service text.
    TosEnabled bool
    Enable terms of service acceptance requirement.
    UnsplashAuthorName string
    Name of the Unsplash author for gallery background.
    UnsplashAuthorUsername string
    Username of the Unsplash author for gallery background.
    WelcomeText string
    Welcome text displayed on the portal.
    WelcomeTextEnabled bool
    Enable welcome text display.
    WelcomeTextPosition string
    Position of the welcome text. Valid values are: under_logo, above_boxes.
    authenticationText String
    Custom authentication text for the portal.
    bgColor String
    Background color for the custom portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    bgImageFileId String
    ID of the background image portal file. File must exist in controller, use unifi.port.AlFile to manage it.
    bgImageTile Boolean
    Tile the background image.
    bgType String
    Type of portal background. Valid values are:
    boxColor String
    Color of the login box in the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    boxLinkColor String
    Color of links in the login box. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    boxOpacity Integer
    Opacity of the login box (0-100).
    boxRadius Integer
    Border radius of the login box in pixels.
    boxTextColor String
    Text color in the login box. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    buttonColor String
    Button color in the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    buttonText String
    Custom text for the login button.
    buttonTextColor String
    Button text color. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    customized Boolean
    Whether the portal is customized.
    languages List<String>
    List of enabled languages for the portal.
    linkColor String
    Color for links in the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    logoFileId String
    ID of the logo image portal file. File must exist in controller, use unifi.port.AlFile to manage it.
    logoPosition String
    Position of the logo in the portal. Valid values are: left, center, right.
    logoSize Integer
    Size of the logo in pixels.
    successText String
    Text displayed after successful authentication.
    textColor String
    Main text color for the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    title String
    Title of the portal page.
    tos String
    Terms of service text.
    tosEnabled Boolean
    Enable terms of service acceptance requirement.
    unsplashAuthorName String
    Name of the Unsplash author for gallery background.
    unsplashAuthorUsername String
    Username of the Unsplash author for gallery background.
    welcomeText String
    Welcome text displayed on the portal.
    welcomeTextEnabled Boolean
    Enable welcome text display.
    welcomeTextPosition String
    Position of the welcome text. Valid values are: under_logo, above_boxes.
    authenticationText string
    Custom authentication text for the portal.
    bgColor string
    Background color for the custom portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    bgImageFileId string
    ID of the background image portal file. File must exist in controller, use unifi.port.AlFile to manage it.
    bgImageTile boolean
    Tile the background image.
    bgType string
    Type of portal background. Valid values are:
    boxColor string
    Color of the login box in the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    boxLinkColor string
    Color of links in the login box. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    boxOpacity number
    Opacity of the login box (0-100).
    boxRadius number
    Border radius of the login box in pixels.
    boxTextColor string
    Text color in the login box. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    buttonColor string
    Button color in the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    buttonText string
    Custom text for the login button.
    buttonTextColor string
    Button text color. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    customized boolean
    Whether the portal is customized.
    languages string[]
    List of enabled languages for the portal.
    linkColor string
    Color for links in the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    logoFileId string
    ID of the logo image portal file. File must exist in controller, use unifi.port.AlFile to manage it.
    logoPosition string
    Position of the logo in the portal. Valid values are: left, center, right.
    logoSize number
    Size of the logo in pixels.
    successText string
    Text displayed after successful authentication.
    textColor string
    Main text color for the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    title string
    Title of the portal page.
    tos string
    Terms of service text.
    tosEnabled boolean
    Enable terms of service acceptance requirement.
    unsplashAuthorName string
    Name of the Unsplash author for gallery background.
    unsplashAuthorUsername string
    Username of the Unsplash author for gallery background.
    welcomeText string
    Welcome text displayed on the portal.
    welcomeTextEnabled boolean
    Enable welcome text display.
    welcomeTextPosition string
    Position of the welcome text. Valid values are: under_logo, above_boxes.
    authentication_text str
    Custom authentication text for the portal.
    bg_color str
    Background color for the custom portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    bg_image_file_id str
    ID of the background image portal file. File must exist in controller, use unifi.port.AlFile to manage it.
    bg_image_tile bool
    Tile the background image.
    bg_type str
    Type of portal background. Valid values are:
    box_color str
    Color of the login box in the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    box_link_color str
    Color of links in the login box. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    box_opacity int
    Opacity of the login box (0-100).
    box_radius int
    Border radius of the login box in pixels.
    box_text_color str
    Text color in the login box. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    button_color str
    Button color in the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    button_text str
    Custom text for the login button.
    button_text_color str
    Button text color. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    customized bool
    Whether the portal is customized.
    languages Sequence[str]
    List of enabled languages for the portal.
    link_color str
    Color for links in the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    logo_file_id str
    ID of the logo image portal file. File must exist in controller, use unifi.port.AlFile to manage it.
    logo_position str
    Position of the logo in the portal. Valid values are: left, center, right.
    logo_size int
    Size of the logo in pixels.
    success_text str
    Text displayed after successful authentication.
    text_color str
    Main text color for the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    title str
    Title of the portal page.
    tos str
    Terms of service text.
    tos_enabled bool
    Enable terms of service acceptance requirement.
    unsplash_author_name str
    Name of the Unsplash author for gallery background.
    unsplash_author_username str
    Username of the Unsplash author for gallery background.
    welcome_text str
    Welcome text displayed on the portal.
    welcome_text_enabled bool
    Enable welcome text display.
    welcome_text_position str
    Position of the welcome text. Valid values are: under_logo, above_boxes.
    authenticationText String
    Custom authentication text for the portal.
    bgColor String
    Background color for the custom portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    bgImageFileId String
    ID of the background image portal file. File must exist in controller, use unifi.port.AlFile to manage it.
    bgImageTile Boolean
    Tile the background image.
    bgType String
    Type of portal background. Valid values are:
    boxColor String
    Color of the login box in the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    boxLinkColor String
    Color of links in the login box. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    boxOpacity Number
    Opacity of the login box (0-100).
    boxRadius Number
    Border radius of the login box in pixels.
    boxTextColor String
    Text color in the login box. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    buttonColor String
    Button color in the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    buttonText String
    Custom text for the login button.
    buttonTextColor String
    Button text color. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    customized Boolean
    Whether the portal is customized.
    languages List<String>
    List of enabled languages for the portal.
    linkColor String
    Color for links in the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    logoFileId String
    ID of the logo image portal file. File must exist in controller, use unifi.port.AlFile to manage it.
    logoPosition String
    Position of the logo in the portal. Valid values are: left, center, right.
    logoSize Number
    Size of the logo in pixels.
    successText String
    Text displayed after successful authentication.
    textColor String
    Main text color for the portal. Must be a valid hex color code (e.g., #FFF or #FFFFFF).
    title String
    Title of the portal page.
    tos String
    Terms of service text.
    tosEnabled Boolean
    Enable terms of service acceptance requirement.
    unsplashAuthorName String
    Name of the Unsplash author for gallery background.
    unsplashAuthorUsername String
    Username of the Unsplash author for gallery background.
    welcomeText String
    Welcome text displayed on the portal.
    welcomeTextEnabled Boolean
    Enable welcome text display.
    welcomeTextPosition String
    Position of the welcome text. Valid values are: under_logo, above_boxes.

    GuestAccessQuickpay, GuestAccessQuickpayArgs

    AgreementId string
    QuickPay agreement ID.
    ApiKey string
    QuickPay API key.
    MerchantId string
    QuickPay merchant ID.
    UseSandbox bool
    Enable sandbox mode for QuickPay payments.
    AgreementId string
    QuickPay agreement ID.
    ApiKey string
    QuickPay API key.
    MerchantId string
    QuickPay merchant ID.
    UseSandbox bool
    Enable sandbox mode for QuickPay payments.
    agreementId String
    QuickPay agreement ID.
    apiKey String
    QuickPay API key.
    merchantId String
    QuickPay merchant ID.
    useSandbox Boolean
    Enable sandbox mode for QuickPay payments.
    agreementId string
    QuickPay agreement ID.
    apiKey string
    QuickPay API key.
    merchantId string
    QuickPay merchant ID.
    useSandbox boolean
    Enable sandbox mode for QuickPay payments.
    agreement_id str
    QuickPay agreement ID.
    api_key str
    QuickPay API key.
    merchant_id str
    QuickPay merchant ID.
    use_sandbox bool
    Enable sandbox mode for QuickPay payments.
    agreementId String
    QuickPay agreement ID.
    apiKey String
    QuickPay API key.
    merchantId String
    QuickPay merchant ID.
    useSandbox Boolean
    Enable sandbox mode for QuickPay payments.

    GuestAccessRadius, GuestAccessRadiusArgs

    AuthType string
    RADIUS authentication type. Valid values are: chap, mschapv2.
    ProfileId string
    ID of the RADIUS profile to use.
    DisconnectEnabled bool
    Enable RADIUS disconnect messages.
    DisconnectPort int
    Port for RADIUS disconnect messages.
    AuthType string
    RADIUS authentication type. Valid values are: chap, mschapv2.
    ProfileId string
    ID of the RADIUS profile to use.
    DisconnectEnabled bool
    Enable RADIUS disconnect messages.
    DisconnectPort int
    Port for RADIUS disconnect messages.
    authType String
    RADIUS authentication type. Valid values are: chap, mschapv2.
    profileId String
    ID of the RADIUS profile to use.
    disconnectEnabled Boolean
    Enable RADIUS disconnect messages.
    disconnectPort Integer
    Port for RADIUS disconnect messages.
    authType string
    RADIUS authentication type. Valid values are: chap, mschapv2.
    profileId string
    ID of the RADIUS profile to use.
    disconnectEnabled boolean
    Enable RADIUS disconnect messages.
    disconnectPort number
    Port for RADIUS disconnect messages.
    auth_type str
    RADIUS authentication type. Valid values are: chap, mschapv2.
    profile_id str
    ID of the RADIUS profile to use.
    disconnect_enabled bool
    Enable RADIUS disconnect messages.
    disconnect_port int
    Port for RADIUS disconnect messages.
    authType String
    RADIUS authentication type. Valid values are: chap, mschapv2.
    profileId String
    ID of the RADIUS profile to use.
    disconnectEnabled Boolean
    Enable RADIUS disconnect messages.
    disconnectPort Number
    Port for RADIUS disconnect messages.

    GuestAccessRedirect, GuestAccessRedirectArgs

    Url string
    URL to redirect to after authentication. Must be a valid URL.
    ToHttps bool
    Redirect HTTP requests to HTTPS.
    UseHttps bool
    Use HTTPS for the redirect URL.
    Url string
    URL to redirect to after authentication. Must be a valid URL.
    ToHttps bool
    Redirect HTTP requests to HTTPS.
    UseHttps bool
    Use HTTPS for the redirect URL.
    url String
    URL to redirect to after authentication. Must be a valid URL.
    toHttps Boolean
    Redirect HTTP requests to HTTPS.
    useHttps Boolean
    Use HTTPS for the redirect URL.
    url string
    URL to redirect to after authentication. Must be a valid URL.
    toHttps boolean
    Redirect HTTP requests to HTTPS.
    useHttps boolean
    Use HTTPS for the redirect URL.
    url str
    URL to redirect to after authentication. Must be a valid URL.
    to_https bool
    Redirect HTTP requests to HTTPS.
    use_https bool
    Use HTTPS for the redirect URL.
    url String
    URL to redirect to after authentication. Must be a valid URL.
    toHttps Boolean
    Redirect HTTP requests to HTTPS.
    useHttps Boolean
    Use HTTPS for the redirect URL.

    GuestAccessStripe, GuestAccessStripeArgs

    ApiKey string
    Stripe API key.
    ApiKey string
    Stripe API key.
    apiKey String
    Stripe API key.
    apiKey string
    Stripe API key.
    api_key str
    Stripe API key.
    apiKey String
    Stripe API key.

    GuestAccessWechat, GuestAccessWechatArgs

    AppId string
    WeChat App ID for social authentication.
    AppSecret string
    WeChat App secret.
    SecretKey string
    WeChat secret key.
    ShopId string
    WeChat Shop ID for payments.
    AppId string
    WeChat App ID for social authentication.
    AppSecret string
    WeChat App secret.
    SecretKey string
    WeChat secret key.
    ShopId string
    WeChat Shop ID for payments.
    appId String
    WeChat App ID for social authentication.
    appSecret String
    WeChat App secret.
    secretKey String
    WeChat secret key.
    shopId String
    WeChat Shop ID for payments.
    appId string
    WeChat App ID for social authentication.
    appSecret string
    WeChat App secret.
    secretKey string
    WeChat secret key.
    shopId string
    WeChat Shop ID for payments.
    app_id str
    WeChat App ID for social authentication.
    app_secret str
    WeChat App secret.
    secret_key str
    WeChat secret key.
    shop_id str
    WeChat Shop ID for payments.
    appId String
    WeChat App ID for social authentication.
    appSecret String
    WeChat App secret.
    secretKey String
    WeChat secret key.
    shopId String
    WeChat Shop ID for payments.

    Package Details

    Repository
    unifi pulumiverse/pulumi-unifi
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the unifi Terraform Provider.
    unifi logo
    Viewing docs for Unifi v0.2.0
    published on Tuesday, Feb 17, 2026 by Pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-unifi
      Try Pulumi Cloud free. Your team will thank you.