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

unifi.iam.User

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

    The unifi.iam.User resource manages network clients in the UniFi controller, which are identified by their unique MAC addresses.

    This resource allows you to manage:

    • Fixed IP assignments
    • User groups and network access
    • Network blocking and restrictions
    • Local DNS records

    Important Notes:

    • Users are automatically created in the controller when devices connect to the network
    • By default, this resource can take over management of existing users (controlled by allow_existing)
    • Users can be ‘forgotten’ on destroy (controlled by skip_forget_on_destroy)

    This resource is particularly useful for:

    • Managing static IP assignments
    • Implementing access control
    • Setting up local DNS records
    • Organizing devices into user groups

    Example Usage

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

const test = new unifi.iam.User("test", {
    mac: "01:23:45:67:89:AB",
    name: "some client",
    note: "my note",
    fixedIp: "10.0.0.50",
    networkId: myVlan.id,
});

    import pulumi
import pulumiverse_unifi as unifi

test = unifi.iam.User("test",
    mac="01:23:45:67:89:AB",
    name="some client",
    note="my note",
    fixed_ip="10.0.0.50",
    network_id=my_vlan["id"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iam.NewUser(ctx, "test", &iam.UserArgs{
			Mac:       pulumi.String("01:23:45:67:89:AB"),
			Name:      pulumi.String("some client"),
			Note:      pulumi.String("my note"),
			FixedIp:   pulumi.String("10.0.0.50"),
			NetworkId: pulumi.Any(myVlan.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var test = new Unifi.IAM.User("test", new()
    {
        Mac = "01:23:45:67:89:AB",
        Name = "some client",
        Note = "my note",
        FixedIp = "10.0.0.50",
        NetworkId = myVlan.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumiverse.unifi.iam.User;
import com.pulumiverse.unifi.iam.UserArgs;
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) {
        var test = new User("test", UserArgs.builder()
            .mac("01:23:45:67:89:AB")
            .name("some client")
            .note("my note")
            .fixedIp("10.0.0.50")
            .networkId(myVlan.id())
            .build());

    }
}

    resources:
  test:
    type: unifi:iam:User
    properties:
      mac: 01:23:45:67:89:AB
      name: some client
      note: my note
      fixedIp: 10.0.0.50
      networkId: ${myVlan.id}

    Create User Resource

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

    Constructor syntax

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

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         mac: Optional[str] = None,
         allow_existing: Optional[bool] = None,
         blocked: Optional[bool] = None,
         dev_id_override: Optional[int] = None,
         fixed_ip: Optional[str] = None,
         local_dns_record: Optional[str] = None,
         name: Optional[str] = None,
         network_id: Optional[str] = None,
         note: Optional[str] = None,
         site: Optional[str] = None,
         skip_forget_on_destroy: Optional[bool] = None,
         user_group_id: Optional[str] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

    type: unifi:iam:User
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 UserArgs
    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 UserArgs
    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 UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    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 userResource = new Unifi.IAM.User("userResource", new()
{
    Mac = "string",
    AllowExisting = false,
    Blocked = false,
    DevIdOverride = 0,
    FixedIp = "string",
    LocalDnsRecord = "string",
    Name = "string",
    NetworkId = "string",
    Note = "string",
    Site = "string",
    SkipForgetOnDestroy = false,
    UserGroupId = "string",
});

    example, err := iam.NewUser(ctx, "userResource", &iam.UserArgs{
	Mac:                 pulumi.String("string"),
	AllowExisting:       pulumi.Bool(false),
	Blocked:             pulumi.Bool(false),
	DevIdOverride:       pulumi.Int(0),
	FixedIp:             pulumi.String("string"),
	LocalDnsRecord:      pulumi.String("string"),
	Name:                pulumi.String("string"),
	NetworkId:           pulumi.String("string"),
	Note:                pulumi.String("string"),
	Site:                pulumi.String("string"),
	SkipForgetOnDestroy: pulumi.Bool(false),
	UserGroupId:         pulumi.String("string"),
})

    var userResource = new User("userResource", UserArgs.builder()
    .mac("string")
    .allowExisting(false)
    .blocked(false)
    .devIdOverride(0)
    .fixedIp("string")
    .localDnsRecord("string")
    .name("string")
    .networkId("string")
    .note("string")
    .site("string")
    .skipForgetOnDestroy(false)
    .userGroupId("string")
    .build());

    user_resource = unifi.iam.User("userResource",
    mac="string",
    allow_existing=False,
    blocked=False,
    dev_id_override=0,
    fixed_ip="string",
    local_dns_record="string",
    name="string",
    network_id="string",
    note="string",
    site="string",
    skip_forget_on_destroy=False,
    user_group_id="string")

    const userResource = new unifi.iam.User("userResource", {
    mac: "string",
    allowExisting: false,
    blocked: false,
    devIdOverride: 0,
    fixedIp: "string",
    localDnsRecord: "string",
    name: "string",
    networkId: "string",
    note: "string",
    site: "string",
    skipForgetOnDestroy: false,
    userGroupId: "string",
});

    type: unifi:iam:User
properties:
    allowExisting: false
    blocked: false
    devIdOverride: 0
    fixedIp: string
    localDnsRecord: string
    mac: string
    name: string
    networkId: string
    note: string
    site: string
    skipForgetOnDestroy: false
    userGroupId: string

    User 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 User resource accepts the following input properties:

    Mac string
    The MAC address of the device/client. This is used as the unique identifier and cannot be changed after creation. Must be a valid MAC address format (e.g., '00:11:22:33:44:55'). MAC addresses are case-insensitive.
    AllowExisting bool

    Allow this resource to take over management of an existing user in the UniFi controller. When true:

    • The resource can manage users that were automatically created when devices connected
    • Existing settings will be overwritten with the values specified in this resource
    • If false, attempting to manage an existing user will result in an error

    Use with caution as it can modify settings for devices already connected to your network.

    Blocked bool
    When true, this client will be blocked from accessing the network. Useful for temporarily or permanently restricting network access for specific devices.
    DevIdOverride int
    Override the device fingerprint.
    FixedIp string
    A static IPv4 address to assign to this client. Ensure this IP is within the client's network range and not already assigned to another device.
    LocalDnsRecord string
    A local DNS hostname for this client. When set, other devices on the network can resolve this name to the client's IP address (e.g., 'printer.local', 'nas.home.arpa'). Such DNS record is automatically added to controller's DNS records.
    Name string
    A friendly name for the device/client. This helps identify the device in the UniFi interface (eg. 'Living Room TV', 'John's Laptop').
    NetworkId string
    The ID of the network this client should be associated with. This is particularly important when using VLANs or multiple networks.
    Note string
    Additional information about the client that you want to record (e.g., 'Company asset tag #12345', 'Guest device - expires 2024-03-01').
    Site string
    The name of the UniFi site where this user should be managed. If not specified, the default site will be used.
    SkipForgetOnDestroy bool
    When false (default), the client will be 'forgotten' by the controller when this resource is destroyed. Set to true to keep the client's history in the controller after the resource is removed from Terraform.
    UserGroupId string
    The ID of the user group this client belongs to. User groups can be used to apply common settings and restrictions to multiple clients.
    Mac string
    The MAC address of the device/client. This is used as the unique identifier and cannot be changed after creation. Must be a valid MAC address format (e.g., '00:11:22:33:44:55'). MAC addresses are case-insensitive.
    AllowExisting bool

    Allow this resource to take over management of an existing user in the UniFi controller. When true:

    • The resource can manage users that were automatically created when devices connected
    • Existing settings will be overwritten with the values specified in this resource
    • If false, attempting to manage an existing user will result in an error

    Use with caution as it can modify settings for devices already connected to your network.

    Blocked bool
    When true, this client will be blocked from accessing the network. Useful for temporarily or permanently restricting network access for specific devices.
    DevIdOverride int
    Override the device fingerprint.
    FixedIp string
    A static IPv4 address to assign to this client. Ensure this IP is within the client's network range and not already assigned to another device.
    LocalDnsRecord string
    A local DNS hostname for this client. When set, other devices on the network can resolve this name to the client's IP address (e.g., 'printer.local', 'nas.home.arpa'). Such DNS record is automatically added to controller's DNS records.
    Name string
    A friendly name for the device/client. This helps identify the device in the UniFi interface (eg. 'Living Room TV', 'John's Laptop').
    NetworkId string
    The ID of the network this client should be associated with. This is particularly important when using VLANs or multiple networks.
    Note string
    Additional information about the client that you want to record (e.g., 'Company asset tag #12345', 'Guest device - expires 2024-03-01').
    Site string
    The name of the UniFi site where this user should be managed. If not specified, the default site will be used.
    SkipForgetOnDestroy bool
    When false (default), the client will be 'forgotten' by the controller when this resource is destroyed. Set to true to keep the client's history in the controller after the resource is removed from Terraform.
    UserGroupId string
    The ID of the user group this client belongs to. User groups can be used to apply common settings and restrictions to multiple clients.
    mac String
    The MAC address of the device/client. This is used as the unique identifier and cannot be changed after creation. Must be a valid MAC address format (e.g., '00:11:22:33:44:55'). MAC addresses are case-insensitive.
    allowExisting Boolean

    Allow this resource to take over management of an existing user in the UniFi controller. When true:

    • The resource can manage users that were automatically created when devices connected
    • Existing settings will be overwritten with the values specified in this resource
    • If false, attempting to manage an existing user will result in an error

    Use with caution as it can modify settings for devices already connected to your network.

    blocked Boolean
    When true, this client will be blocked from accessing the network. Useful for temporarily or permanently restricting network access for specific devices.
    devIdOverride Integer
    Override the device fingerprint.
    fixedIp String
    A static IPv4 address to assign to this client. Ensure this IP is within the client's network range and not already assigned to another device.
    localDnsRecord String
    A local DNS hostname for this client. When set, other devices on the network can resolve this name to the client's IP address (e.g., 'printer.local', 'nas.home.arpa'). Such DNS record is automatically added to controller's DNS records.
    name String
    A friendly name for the device/client. This helps identify the device in the UniFi interface (eg. 'Living Room TV', 'John's Laptop').
    networkId String
    The ID of the network this client should be associated with. This is particularly important when using VLANs or multiple networks.
    note String
    Additional information about the client that you want to record (e.g., 'Company asset tag #12345', 'Guest device - expires 2024-03-01').
    site String
    The name of the UniFi site where this user should be managed. If not specified, the default site will be used.
    skipForgetOnDestroy Boolean
    When false (default), the client will be 'forgotten' by the controller when this resource is destroyed. Set to true to keep the client's history in the controller after the resource is removed from Terraform.
    userGroupId String
    The ID of the user group this client belongs to. User groups can be used to apply common settings and restrictions to multiple clients.
    mac string
    The MAC address of the device/client. This is used as the unique identifier and cannot be changed after creation. Must be a valid MAC address format (e.g., '00:11:22:33:44:55'). MAC addresses are case-insensitive.
    allowExisting boolean

    Allow this resource to take over management of an existing user in the UniFi controller. When true:

    • The resource can manage users that were automatically created when devices connected
    • Existing settings will be overwritten with the values specified in this resource
    • If false, attempting to manage an existing user will result in an error

    Use with caution as it can modify settings for devices already connected to your network.

    blocked boolean
    When true, this client will be blocked from accessing the network. Useful for temporarily or permanently restricting network access for specific devices.
    devIdOverride number
    Override the device fingerprint.
    fixedIp string
    A static IPv4 address to assign to this client. Ensure this IP is within the client's network range and not already assigned to another device.
    localDnsRecord string
    A local DNS hostname for this client. When set, other devices on the network can resolve this name to the client's IP address (e.g., 'printer.local', 'nas.home.arpa'). Such DNS record is automatically added to controller's DNS records.
    name string
    A friendly name for the device/client. This helps identify the device in the UniFi interface (eg. 'Living Room TV', 'John's Laptop').
    networkId string
    The ID of the network this client should be associated with. This is particularly important when using VLANs or multiple networks.
    note string
    Additional information about the client that you want to record (e.g., 'Company asset tag #12345', 'Guest device - expires 2024-03-01').
    site string
    The name of the UniFi site where this user should be managed. If not specified, the default site will be used.
    skipForgetOnDestroy boolean
    When false (default), the client will be 'forgotten' by the controller when this resource is destroyed. Set to true to keep the client's history in the controller after the resource is removed from Terraform.
    userGroupId string
    The ID of the user group this client belongs to. User groups can be used to apply common settings and restrictions to multiple clients.
    mac str
    The MAC address of the device/client. This is used as the unique identifier and cannot be changed after creation. Must be a valid MAC address format (e.g., '00:11:22:33:44:55'). MAC addresses are case-insensitive.
    allow_existing bool

    Allow this resource to take over management of an existing user in the UniFi controller. When true:

    • The resource can manage users that were automatically created when devices connected
    • Existing settings will be overwritten with the values specified in this resource
    • If false, attempting to manage an existing user will result in an error

    Use with caution as it can modify settings for devices already connected to your network.

    blocked bool
    When true, this client will be blocked from accessing the network. Useful for temporarily or permanently restricting network access for specific devices.
    dev_id_override int
    Override the device fingerprint.
    fixed_ip str
    A static IPv4 address to assign to this client. Ensure this IP is within the client's network range and not already assigned to another device.
    local_dns_record str
    A local DNS hostname for this client. When set, other devices on the network can resolve this name to the client's IP address (e.g., 'printer.local', 'nas.home.arpa'). Such DNS record is automatically added to controller's DNS records.
    name str
    A friendly name for the device/client. This helps identify the device in the UniFi interface (eg. 'Living Room TV', 'John's Laptop').
    network_id str
    The ID of the network this client should be associated with. This is particularly important when using VLANs or multiple networks.
    note str
    Additional information about the client that you want to record (e.g., 'Company asset tag #12345', 'Guest device - expires 2024-03-01').
    site str
    The name of the UniFi site where this user should be managed. If not specified, the default site will be used.
    skip_forget_on_destroy bool
    When false (default), the client will be 'forgotten' by the controller when this resource is destroyed. Set to true to keep the client's history in the controller after the resource is removed from Terraform.
    user_group_id str
    The ID of the user group this client belongs to. User groups can be used to apply common settings and restrictions to multiple clients.
    mac String
    The MAC address of the device/client. This is used as the unique identifier and cannot be changed after creation. Must be a valid MAC address format (e.g., '00:11:22:33:44:55'). MAC addresses are case-insensitive.
    allowExisting Boolean

    Allow this resource to take over management of an existing user in the UniFi controller. When true:

    • The resource can manage users that were automatically created when devices connected
    • Existing settings will be overwritten with the values specified in this resource
    • If false, attempting to manage an existing user will result in an error

    Use with caution as it can modify settings for devices already connected to your network.

    blocked Boolean
    When true, this client will be blocked from accessing the network. Useful for temporarily or permanently restricting network access for specific devices.
    devIdOverride Number
    Override the device fingerprint.
    fixedIp String
    A static IPv4 address to assign to this client. Ensure this IP is within the client's network range and not already assigned to another device.
    localDnsRecord String
    A local DNS hostname for this client. When set, other devices on the network can resolve this name to the client's IP address (e.g., 'printer.local', 'nas.home.arpa'). Such DNS record is automatically added to controller's DNS records.
    name String
    A friendly name for the device/client. This helps identify the device in the UniFi interface (eg. 'Living Room TV', 'John's Laptop').
    networkId String
    The ID of the network this client should be associated with. This is particularly important when using VLANs or multiple networks.
    note String
    Additional information about the client that you want to record (e.g., 'Company asset tag #12345', 'Guest device - expires 2024-03-01').
    site String
    The name of the UniFi site where this user should be managed. If not specified, the default site will be used.
    skipForgetOnDestroy Boolean
    When false (default), the client will be 'forgotten' by the controller when this resource is destroyed. Set to true to keep the client's history in the controller after the resource is removed from Terraform.
    userGroupId String
    The ID of the user group this client belongs to. User groups can be used to apply common settings and restrictions to multiple clients.

    Outputs

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

    Hostname string
    The hostname of the user.
    Id string
    The provider-assigned unique ID for this managed resource.
    Ip string
    The IP address of the user.
    Hostname string
    The hostname of the user.
    Id string
    The provider-assigned unique ID for this managed resource.
    Ip string
    The IP address of the user.
    hostname String
    The hostname of the user.
    id String
    The provider-assigned unique ID for this managed resource.
    ip String
    The IP address of the user.
    hostname string
    The hostname of the user.
    id string
    The provider-assigned unique ID for this managed resource.
    ip string
    The IP address of the user.
    hostname str
    The hostname of the user.
    id str
    The provider-assigned unique ID for this managed resource.
    ip str
    The IP address of the user.
    hostname String
    The hostname of the user.
    id String
    The provider-assigned unique ID for this managed resource.
    ip String
    The IP address of the user.

    Look up Existing User Resource

    Get an existing User 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?: UserState, opts?: CustomResourceOptions): User
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_existing: Optional[bool] = None,
        blocked: Optional[bool] = None,
        dev_id_override: Optional[int] = None,
        fixed_ip: Optional[str] = None,
        hostname: Optional[str] = None,
        ip: Optional[str] = None,
        local_dns_record: Optional[str] = None,
        mac: Optional[str] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        note: Optional[str] = None,
        site: Optional[str] = None,
        skip_forget_on_destroy: Optional[bool] = None,
        user_group_id: Optional[str] = None) -> User
    func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
    public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
    public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
    resources:  _:    type: unifi:iam:User    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:
    AllowExisting bool

    Allow this resource to take over management of an existing user in the UniFi controller. When true:

    • The resource can manage users that were automatically created when devices connected
    • Existing settings will be overwritten with the values specified in this resource
    • If false, attempting to manage an existing user will result in an error

    Use with caution as it can modify settings for devices already connected to your network.

    Blocked bool
    When true, this client will be blocked from accessing the network. Useful for temporarily or permanently restricting network access for specific devices.
    DevIdOverride int
    Override the device fingerprint.
    FixedIp string
    A static IPv4 address to assign to this client. Ensure this IP is within the client's network range and not already assigned to another device.
    Hostname string
    The hostname of the user.
    Ip string
    The IP address of the user.
    LocalDnsRecord string
    A local DNS hostname for this client. When set, other devices on the network can resolve this name to the client's IP address (e.g., 'printer.local', 'nas.home.arpa'). Such DNS record is automatically added to controller's DNS records.
    Mac string
    The MAC address of the device/client. This is used as the unique identifier and cannot be changed after creation. Must be a valid MAC address format (e.g., '00:11:22:33:44:55'). MAC addresses are case-insensitive.
    Name string
    A friendly name for the device/client. This helps identify the device in the UniFi interface (eg. 'Living Room TV', 'John's Laptop').
    NetworkId string
    The ID of the network this client should be associated with. This is particularly important when using VLANs or multiple networks.
    Note string
    Additional information about the client that you want to record (e.g., 'Company asset tag #12345', 'Guest device - expires 2024-03-01').
    Site string
    The name of the UniFi site where this user should be managed. If not specified, the default site will be used.
    SkipForgetOnDestroy bool
    When false (default), the client will be 'forgotten' by the controller when this resource is destroyed. Set to true to keep the client's history in the controller after the resource is removed from Terraform.
    UserGroupId string
    The ID of the user group this client belongs to. User groups can be used to apply common settings and restrictions to multiple clients.
    AllowExisting bool

    Allow this resource to take over management of an existing user in the UniFi controller. When true:

    • The resource can manage users that were automatically created when devices connected
    • Existing settings will be overwritten with the values specified in this resource
    • If false, attempting to manage an existing user will result in an error

    Use with caution as it can modify settings for devices already connected to your network.

    Blocked bool
    When true, this client will be blocked from accessing the network. Useful for temporarily or permanently restricting network access for specific devices.
    DevIdOverride int
    Override the device fingerprint.
    FixedIp string
    A static IPv4 address to assign to this client. Ensure this IP is within the client's network range and not already assigned to another device.
    Hostname string
    The hostname of the user.
    Ip string
    The IP address of the user.
    LocalDnsRecord string
    A local DNS hostname for this client. When set, other devices on the network can resolve this name to the client's IP address (e.g., 'printer.local', 'nas.home.arpa'). Such DNS record is automatically added to controller's DNS records.
    Mac string
    The MAC address of the device/client. This is used as the unique identifier and cannot be changed after creation. Must be a valid MAC address format (e.g., '00:11:22:33:44:55'). MAC addresses are case-insensitive.
    Name string
    A friendly name for the device/client. This helps identify the device in the UniFi interface (eg. 'Living Room TV', 'John's Laptop').
    NetworkId string
    The ID of the network this client should be associated with. This is particularly important when using VLANs or multiple networks.
    Note string
    Additional information about the client that you want to record (e.g., 'Company asset tag #12345', 'Guest device - expires 2024-03-01').
    Site string
    The name of the UniFi site where this user should be managed. If not specified, the default site will be used.
    SkipForgetOnDestroy bool
    When false (default), the client will be 'forgotten' by the controller when this resource is destroyed. Set to true to keep the client's history in the controller after the resource is removed from Terraform.
    UserGroupId string
    The ID of the user group this client belongs to. User groups can be used to apply common settings and restrictions to multiple clients.
    allowExisting Boolean

    Allow this resource to take over management of an existing user in the UniFi controller. When true:

    • The resource can manage users that were automatically created when devices connected
    • Existing settings will be overwritten with the values specified in this resource
    • If false, attempting to manage an existing user will result in an error

    Use with caution as it can modify settings for devices already connected to your network.

    blocked Boolean
    When true, this client will be blocked from accessing the network. Useful for temporarily or permanently restricting network access for specific devices.
    devIdOverride Integer
    Override the device fingerprint.
    fixedIp String
    A static IPv4 address to assign to this client. Ensure this IP is within the client's network range and not already assigned to another device.
    hostname String
    The hostname of the user.
    ip String
    The IP address of the user.
    localDnsRecord String
    A local DNS hostname for this client. When set, other devices on the network can resolve this name to the client's IP address (e.g., 'printer.local', 'nas.home.arpa'). Such DNS record is automatically added to controller's DNS records.
    mac String
    The MAC address of the device/client. This is used as the unique identifier and cannot be changed after creation. Must be a valid MAC address format (e.g., '00:11:22:33:44:55'). MAC addresses are case-insensitive.
    name String
    A friendly name for the device/client. This helps identify the device in the UniFi interface (eg. 'Living Room TV', 'John's Laptop').
    networkId String
    The ID of the network this client should be associated with. This is particularly important when using VLANs or multiple networks.
    note String
    Additional information about the client that you want to record (e.g., 'Company asset tag #12345', 'Guest device - expires 2024-03-01').
    site String
    The name of the UniFi site where this user should be managed. If not specified, the default site will be used.
    skipForgetOnDestroy Boolean
    When false (default), the client will be 'forgotten' by the controller when this resource is destroyed. Set to true to keep the client's history in the controller after the resource is removed from Terraform.
    userGroupId String
    The ID of the user group this client belongs to. User groups can be used to apply common settings and restrictions to multiple clients.
    allowExisting boolean

    Allow this resource to take over management of an existing user in the UniFi controller. When true:

    • The resource can manage users that were automatically created when devices connected
    • Existing settings will be overwritten with the values specified in this resource
    • If false, attempting to manage an existing user will result in an error

    Use with caution as it can modify settings for devices already connected to your network.

    blocked boolean
    When true, this client will be blocked from accessing the network. Useful for temporarily or permanently restricting network access for specific devices.
    devIdOverride number
    Override the device fingerprint.
    fixedIp string
    A static IPv4 address to assign to this client. Ensure this IP is within the client's network range and not already assigned to another device.
    hostname string
    The hostname of the user.
    ip string
    The IP address of the user.
    localDnsRecord string
    A local DNS hostname for this client. When set, other devices on the network can resolve this name to the client's IP address (e.g., 'printer.local', 'nas.home.arpa'). Such DNS record is automatically added to controller's DNS records.
    mac string
    The MAC address of the device/client. This is used as the unique identifier and cannot be changed after creation. Must be a valid MAC address format (e.g., '00:11:22:33:44:55'). MAC addresses are case-insensitive.
    name string
    A friendly name for the device/client. This helps identify the device in the UniFi interface (eg. 'Living Room TV', 'John's Laptop').
    networkId string
    The ID of the network this client should be associated with. This is particularly important when using VLANs or multiple networks.
    note string
    Additional information about the client that you want to record (e.g., 'Company asset tag #12345', 'Guest device - expires 2024-03-01').
    site string
    The name of the UniFi site where this user should be managed. If not specified, the default site will be used.
    skipForgetOnDestroy boolean
    When false (default), the client will be 'forgotten' by the controller when this resource is destroyed. Set to true to keep the client's history in the controller after the resource is removed from Terraform.
    userGroupId string
    The ID of the user group this client belongs to. User groups can be used to apply common settings and restrictions to multiple clients.
    allow_existing bool

    Allow this resource to take over management of an existing user in the UniFi controller. When true:

    • The resource can manage users that were automatically created when devices connected
    • Existing settings will be overwritten with the values specified in this resource
    • If false, attempting to manage an existing user will result in an error

    Use with caution as it can modify settings for devices already connected to your network.

    blocked bool
    When true, this client will be blocked from accessing the network. Useful for temporarily or permanently restricting network access for specific devices.
    dev_id_override int
    Override the device fingerprint.
    fixed_ip str
    A static IPv4 address to assign to this client. Ensure this IP is within the client's network range and not already assigned to another device.
    hostname str
    The hostname of the user.
    ip str
    The IP address of the user.
    local_dns_record str
    A local DNS hostname for this client. When set, other devices on the network can resolve this name to the client's IP address (e.g., 'printer.local', 'nas.home.arpa'). Such DNS record is automatically added to controller's DNS records.
    mac str
    The MAC address of the device/client. This is used as the unique identifier and cannot be changed after creation. Must be a valid MAC address format (e.g., '00:11:22:33:44:55'). MAC addresses are case-insensitive.
    name str
    A friendly name for the device/client. This helps identify the device in the UniFi interface (eg. 'Living Room TV', 'John's Laptop').
    network_id str
    The ID of the network this client should be associated with. This is particularly important when using VLANs or multiple networks.
    note str
    Additional information about the client that you want to record (e.g., 'Company asset tag #12345', 'Guest device - expires 2024-03-01').
    site str
    The name of the UniFi site where this user should be managed. If not specified, the default site will be used.
    skip_forget_on_destroy bool
    When false (default), the client will be 'forgotten' by the controller when this resource is destroyed. Set to true to keep the client's history in the controller after the resource is removed from Terraform.
    user_group_id str
    The ID of the user group this client belongs to. User groups can be used to apply common settings and restrictions to multiple clients.
    allowExisting Boolean

    Allow this resource to take over management of an existing user in the UniFi controller. When true:

    • The resource can manage users that were automatically created when devices connected
    • Existing settings will be overwritten with the values specified in this resource
    • If false, attempting to manage an existing user will result in an error

    Use with caution as it can modify settings for devices already connected to your network.

    blocked Boolean
    When true, this client will be blocked from accessing the network. Useful for temporarily or permanently restricting network access for specific devices.
    devIdOverride Number
    Override the device fingerprint.
    fixedIp String
    A static IPv4 address to assign to this client. Ensure this IP is within the client's network range and not already assigned to another device.
    hostname String
    The hostname of the user.
    ip String
    The IP address of the user.
    localDnsRecord String
    A local DNS hostname for this client. When set, other devices on the network can resolve this name to the client's IP address (e.g., 'printer.local', 'nas.home.arpa'). Such DNS record is automatically added to controller's DNS records.
    mac String
    The MAC address of the device/client. This is used as the unique identifier and cannot be changed after creation. Must be a valid MAC address format (e.g., '00:11:22:33:44:55'). MAC addresses are case-insensitive.
    name String
    A friendly name for the device/client. This helps identify the device in the UniFi interface (eg. 'Living Room TV', 'John's Laptop').
    networkId String
    The ID of the network this client should be associated with. This is particularly important when using VLANs or multiple networks.
    note String
    Additional information about the client that you want to record (e.g., 'Company asset tag #12345', 'Guest device - expires 2024-03-01').
    site String
    The name of the UniFi site where this user should be managed. If not specified, the default site will be used.
    skipForgetOnDestroy Boolean
    When false (default), the client will be 'forgotten' by the controller when this resource is destroyed. Set to true to keep the client's history in the controller after the resource is removed from Terraform.
    userGroupId String
    The ID of the user group this client belongs to. User groups can be used to apply common settings and restrictions to multiple clients.

    Package Details

    Repository
    unifi pulumiverse/pulumi-unifi
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the unifi Terraform Provider.
    unifi logo
    Unifi v0.2.0 published on Tuesday, Feb 17, 2026 by Pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-unifi
      Meet Neo: Your AI Platform Teammate