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

unifi.iam.Group

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

    The unifi.iam.Group resource manages client groups in the UniFi controller, which allow you to apply common settings and restrictions to multiple network clients.

    User groups are primarily used for:

    • Implementing Quality of Service (QoS) policies
    • Setting bandwidth limits for different types of users
    • Organizing clients into logical groups (e.g., Staff, Guests, IoT devices)

    Key features include:

    • Download rate limiting
    • Upload rate limiting
    • Group-based policy application

    User groups are particularly useful in:

    • Educational environments (different policies for staff and students)
    • Guest networks (limiting guest bandwidth)
    • Shared office spaces (managing different tenant groups)

    Example Usage

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

const wifi = new unifi.iam.Group("wifi", {
    name: "wifi",
    qosRateMaxDown: 2000,
    qosRateMaxUp: 10,
});

    import pulumi
import pulumiverse_unifi as unifi

wifi = unifi.iam.Group("wifi",
    name="wifi",
    qos_rate_max_down=2000,
    qos_rate_max_up=10)

    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.NewGroup(ctx, "wifi", &iam.GroupArgs{
			Name:           pulumi.String("wifi"),
			QosRateMaxDown: pulumi.Int(2000),
			QosRateMaxUp:   pulumi.Int(10),
		})
		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 wifi = new Unifi.IAM.Group("wifi", new()
    {
        Name = "wifi",
        QosRateMaxDown = 2000,
        QosRateMaxUp = 10,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumiverse.unifi.iam.Group;
import com.pulumiverse.unifi.iam.GroupArgs;
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 wifi = new Group("wifi", GroupArgs.builder()
            .name("wifi")
            .qosRateMaxDown(2000)
            .qosRateMaxUp(10)
            .build());

    }
}

    resources:
  wifi:
    type: unifi:iam:Group
    properties:
      name: wifi
      qosRateMaxDown: 2000 # 2mbps
      qosRateMaxUp: 10 # 10kbps

    Create Group Resource

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

    Constructor syntax

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

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          name: Optional[str] = None,
          qos_rate_max_down: Optional[int] = None,
          qos_rate_max_up: Optional[int] = None,
          site: Optional[str] = None)
    func NewGroup(ctx *Context, name string, args *GroupArgs, opts ...ResourceOption) (*Group, error)
    public Group(string name, GroupArgs? args = null, CustomResourceOptions? opts = null)
    public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

    type: unifi:iam:Group
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 GroupArgs
    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 GroupArgs
    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 GroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupArgs
    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 unifiGroupResource = new Unifi.IAM.Group("unifiGroupResource", new()
{
    Name = "string",
    QosRateMaxDown = 0,
    QosRateMaxUp = 0,
    Site = "string",
});

    example, err := iam.NewGroup(ctx, "unifiGroupResource", &iam.GroupArgs{
	Name:           pulumi.String("string"),
	QosRateMaxDown: pulumi.Int(0),
	QosRateMaxUp:   pulumi.Int(0),
	Site:           pulumi.String("string"),
})

    var unifiGroupResource = new com.pulumiverse.unifi.iam.Group("unifiGroupResource", com.pulumiverse.unifi.iam.GroupArgs.builder()
    .name("string")
    .qosRateMaxDown(0)
    .qosRateMaxUp(0)
    .site("string")
    .build());

    unifi_group_resource = unifi.iam.Group("unifiGroupResource",
    name="string",
    qos_rate_max_down=0,
    qos_rate_max_up=0,
    site="string")

    const unifiGroupResource = new unifi.iam.Group("unifiGroupResource", {
    name: "string",
    qosRateMaxDown: 0,
    qosRateMaxUp: 0,
    site: "string",
});

    type: unifi:iam:Group
properties:
    name: string
    qosRateMaxDown: 0
    qosRateMaxUp: 0
    site: string

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

    Name string
    A descriptive name for the user group (e.g., 'Staff', 'Guests', 'IoT Devices'). This name will be displayed in the UniFi controller interface and used when assigning clients to the group.
    QosRateMaxDown int
    The maximum allowed download speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    QosRateMaxUp int
    The maximum allowed upload speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    Site string
    The name of the UniFi site where this user group should be created. If not specified, the default site will be used.
    Name string
    A descriptive name for the user group (e.g., 'Staff', 'Guests', 'IoT Devices'). This name will be displayed in the UniFi controller interface and used when assigning clients to the group.
    QosRateMaxDown int
    The maximum allowed download speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    QosRateMaxUp int
    The maximum allowed upload speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    Site string
    The name of the UniFi site where this user group should be created. If not specified, the default site will be used.
    name String
    A descriptive name for the user group (e.g., 'Staff', 'Guests', 'IoT Devices'). This name will be displayed in the UniFi controller interface and used when assigning clients to the group.
    qosRateMaxDown Integer
    The maximum allowed download speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    qosRateMaxUp Integer
    The maximum allowed upload speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    site String
    The name of the UniFi site where this user group should be created. If not specified, the default site will be used.
    name string
    A descriptive name for the user group (e.g., 'Staff', 'Guests', 'IoT Devices'). This name will be displayed in the UniFi controller interface and used when assigning clients to the group.
    qosRateMaxDown number
    The maximum allowed download speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    qosRateMaxUp number
    The maximum allowed upload speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    site string
    The name of the UniFi site where this user group should be created. If not specified, the default site will be used.
    name str
    A descriptive name for the user group (e.g., 'Staff', 'Guests', 'IoT Devices'). This name will be displayed in the UniFi controller interface and used when assigning clients to the group.
    qos_rate_max_down int
    The maximum allowed download speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    qos_rate_max_up int
    The maximum allowed upload speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    site str
    The name of the UniFi site where this user group should be created. If not specified, the default site will be used.
    name String
    A descriptive name for the user group (e.g., 'Staff', 'Guests', 'IoT Devices'). This name will be displayed in the UniFi controller interface and used when assigning clients to the group.
    qosRateMaxDown Number
    The maximum allowed download speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    qosRateMaxUp Number
    The maximum allowed upload speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    site String
    The name of the UniFi site where this user group should be created. If not specified, the default site will be used.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Group Resource

    Get an existing Group 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?: GroupState, opts?: CustomResourceOptions): Group
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        qos_rate_max_down: Optional[int] = None,
        qos_rate_max_up: Optional[int] = None,
        site: Optional[str] = None) -> Group
    func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
    public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
    public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
    resources:  _:    type: unifi:iam:Group    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:
    Name string
    A descriptive name for the user group (e.g., 'Staff', 'Guests', 'IoT Devices'). This name will be displayed in the UniFi controller interface and used when assigning clients to the group.
    QosRateMaxDown int
    The maximum allowed download speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    QosRateMaxUp int
    The maximum allowed upload speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    Site string
    The name of the UniFi site where this user group should be created. If not specified, the default site will be used.
    Name string
    A descriptive name for the user group (e.g., 'Staff', 'Guests', 'IoT Devices'). This name will be displayed in the UniFi controller interface and used when assigning clients to the group.
    QosRateMaxDown int
    The maximum allowed download speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    QosRateMaxUp int
    The maximum allowed upload speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    Site string
    The name of the UniFi site where this user group should be created. If not specified, the default site will be used.
    name String
    A descriptive name for the user group (e.g., 'Staff', 'Guests', 'IoT Devices'). This name will be displayed in the UniFi controller interface and used when assigning clients to the group.
    qosRateMaxDown Integer
    The maximum allowed download speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    qosRateMaxUp Integer
    The maximum allowed upload speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    site String
    The name of the UniFi site where this user group should be created. If not specified, the default site will be used.
    name string
    A descriptive name for the user group (e.g., 'Staff', 'Guests', 'IoT Devices'). This name will be displayed in the UniFi controller interface and used when assigning clients to the group.
    qosRateMaxDown number
    The maximum allowed download speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    qosRateMaxUp number
    The maximum allowed upload speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    site string
    The name of the UniFi site where this user group should be created. If not specified, the default site will be used.
    name str
    A descriptive name for the user group (e.g., 'Staff', 'Guests', 'IoT Devices'). This name will be displayed in the UniFi controller interface and used when assigning clients to the group.
    qos_rate_max_down int
    The maximum allowed download speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    qos_rate_max_up int
    The maximum allowed upload speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    site str
    The name of the UniFi site where this user group should be created. If not specified, the default site will be used.
    name String
    A descriptive name for the user group (e.g., 'Staff', 'Guests', 'IoT Devices'). This name will be displayed in the UniFi controller interface and used when assigning clients to the group.
    qosRateMaxDown Number
    The maximum allowed download speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    qosRateMaxUp Number
    The maximum allowed upload speed in Kbps (kilobits per second) for clients in this group. Set to -1 for unlimited. Note: Values of 0 or 1 are not allowed. Defaults to -1.
    site String
    The name of the UniFi site where this user group should be created. If not specified, the default site will be used.

    Import

    import using the ID

    $ pulumi import unifi:iam/group:Group wifi 5fe6261995fe130013456a36

    To learn more about importing existing cloud resources, see Importing resources.

    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.