Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Twingate
  3. API Docs
  4. getTwingateGroups
Twingate v3.0.18 published on Wednesday, Apr 16, 2025 by Twingate
twingate/pulumi-twingate

twingate.getTwingateGroups

Explore with Pulumi AI

Twingate v3.0.18 published on Wednesday, Apr 16, 2025 by Twingate
twingate/pulumi-twingate

Groups are how users are authorized to access Resources. For more information, see Twingate’s documentation.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as twingate from "@pulumi/twingate";

const foo = twingate.getTwingateGroups({
    name: "<your group's name>",
});
Copy
import pulumi
import pulumi_twingate as twingate

foo = twingate.get_twingate_groups(name="<your group's name>")
Copy
package main

import (
	"github.com/Twingate/pulumi-twingate/sdk/v3/go/twingate"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := twingate.GetTwingateGroups(ctx, &twingate.GetTwingateGroupsArgs{
			Name: pulumi.StringRef("<your group's name>"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Twingate = Pulumi.Twingate;

return await Deployment.RunAsync(() => 
{
    var foo = Twingate.GetTwingateGroups.Invoke(new()
    {
        Name = "<your group's name>",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.twingate.TwingateFunctions;
import com.pulumi.twingate.inputs.GetTwingateGroupsArgs;
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) {
        final var foo = TwingateFunctions.getTwingateGroups(GetTwingateGroupsArgs.builder()
            .name("<your group's name>")
            .build());

    }
}
Copy
variables:
  foo:
    fn::invoke:
      function: twingate:getTwingateGroups
      arguments:
        name: <your group's name>
Copy

Using getTwingateGroups

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getTwingateGroups(args: GetTwingateGroupsArgs, opts?: InvokeOptions): Promise<GetTwingateGroupsResult>
function getTwingateGroupsOutput(args: GetTwingateGroupsOutputArgs, opts?: InvokeOptions): Output<GetTwingateGroupsResult>
Copy
def get_twingate_groups(is_active: Optional[bool] = None,
                        name: Optional[str] = None,
                        name_contains: Optional[str] = None,
                        name_exclude: Optional[str] = None,
                        name_prefix: Optional[str] = None,
                        name_regexp: Optional[str] = None,
                        name_suffix: Optional[str] = None,
                        types: Optional[Sequence[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> GetTwingateGroupsResult
def get_twingate_groups_output(is_active: Optional[pulumi.Input[bool]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        name_contains: Optional[pulumi.Input[str]] = None,
                        name_exclude: Optional[pulumi.Input[str]] = None,
                        name_prefix: Optional[pulumi.Input[str]] = None,
                        name_regexp: Optional[pulumi.Input[str]] = None,
                        name_suffix: Optional[pulumi.Input[str]] = None,
                        types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetTwingateGroupsResult]
Copy
func GetTwingateGroups(ctx *Context, args *GetTwingateGroupsArgs, opts ...InvokeOption) (*GetTwingateGroupsResult, error)
func GetTwingateGroupsOutput(ctx *Context, args *GetTwingateGroupsOutputArgs, opts ...InvokeOption) GetTwingateGroupsResultOutput
Copy

> Note: This function is named GetTwingateGroups in the Go SDK.

public static class GetTwingateGroups 
{
    public static Task<GetTwingateGroupsResult> InvokeAsync(GetTwingateGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetTwingateGroupsResult> Invoke(GetTwingateGroupsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTwingateGroupsResult> getTwingateGroups(GetTwingateGroupsArgs args, InvokeOptions options)
public static Output<GetTwingateGroupsResult> getTwingateGroups(GetTwingateGroupsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: twingate:index/getTwingateGroups:getTwingateGroups
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

IsActive bool
Returns only Groups matching the specified state.
Name string
Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
NameContains string
Match when the value exist in the name of the group.
NameExclude string
Match when the exact value does not exist in the name of the group.
NamePrefix string
The name of the group must start with the value.
NameRegexp string
The regular expression match of the name of the group.
NameSuffix string
The name of the group must end with the value.
Types List<string>
Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.
IsActive bool
Returns only Groups matching the specified state.
Name string
Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
NameContains string
Match when the value exist in the name of the group.
NameExclude string
Match when the exact value does not exist in the name of the group.
NamePrefix string
The name of the group must start with the value.
NameRegexp string
The regular expression match of the name of the group.
NameSuffix string
The name of the group must end with the value.
Types []string
Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.
isActive Boolean
Returns only Groups matching the specified state.
name String
Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
nameContains String
Match when the value exist in the name of the group.
nameExclude String
Match when the exact value does not exist in the name of the group.
namePrefix String
The name of the group must start with the value.
nameRegexp String
The regular expression match of the name of the group.
nameSuffix String
The name of the group must end with the value.
types List<String>
Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.
isActive boolean
Returns only Groups matching the specified state.
name string
Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
nameContains string
Match when the value exist in the name of the group.
nameExclude string
Match when the exact value does not exist in the name of the group.
namePrefix string
The name of the group must start with the value.
nameRegexp string
The regular expression match of the name of the group.
nameSuffix string
The name of the group must end with the value.
types string[]
Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.
is_active bool
Returns only Groups matching the specified state.
name str
Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
name_contains str
Match when the value exist in the name of the group.
name_exclude str
Match when the exact value does not exist in the name of the group.
name_prefix str
The name of the group must start with the value.
name_regexp str
The regular expression match of the name of the group.
name_suffix str
The name of the group must end with the value.
types Sequence[str]
Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.
isActive Boolean
Returns only Groups matching the specified state.
name String
Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
nameContains String
Match when the value exist in the name of the group.
nameExclude String
Match when the exact value does not exist in the name of the group.
namePrefix String
The name of the group must start with the value.
nameRegexp String
The regular expression match of the name of the group.
nameSuffix String
The name of the group must end with the value.
types List<String>
Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.

getTwingateGroups Result

The following output properties are available:

Groups List<Twingate.Twingate.Outputs.GetTwingateGroupsGroup>
List of Groups
Id string
The ID of this resource.
IsActive bool
Returns only Groups matching the specified state.
Name string
Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
NameContains string
Match when the value exist in the name of the group.
NameExclude string
Match when the exact value does not exist in the name of the group.
NamePrefix string
The name of the group must start with the value.
NameRegexp string
The regular expression match of the name of the group.
NameSuffix string
The name of the group must end with the value.
Types List<string>
Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.
Groups []GetTwingateGroupsGroup
List of Groups
Id string
The ID of this resource.
IsActive bool
Returns only Groups matching the specified state.
Name string
Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
NameContains string
Match when the value exist in the name of the group.
NameExclude string
Match when the exact value does not exist in the name of the group.
NamePrefix string
The name of the group must start with the value.
NameRegexp string
The regular expression match of the name of the group.
NameSuffix string
The name of the group must end with the value.
Types []string
Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.
groups List<GetTwingateGroupsGroup>
List of Groups
id String
The ID of this resource.
isActive Boolean
Returns only Groups matching the specified state.
name String
Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
nameContains String
Match when the value exist in the name of the group.
nameExclude String
Match when the exact value does not exist in the name of the group.
namePrefix String
The name of the group must start with the value.
nameRegexp String
The regular expression match of the name of the group.
nameSuffix String
The name of the group must end with the value.
types List<String>
Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.
groups GetTwingateGroupsGroup[]
List of Groups
id string
The ID of this resource.
isActive boolean
Returns only Groups matching the specified state.
name string
Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
nameContains string
Match when the value exist in the name of the group.
nameExclude string
Match when the exact value does not exist in the name of the group.
namePrefix string
The name of the group must start with the value.
nameRegexp string
The regular expression match of the name of the group.
nameSuffix string
The name of the group must end with the value.
types string[]
Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.
groups Sequence[GetTwingateGroupsGroup]
List of Groups
id str
The ID of this resource.
is_active bool
Returns only Groups matching the specified state.
name str
Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
name_contains str
Match when the value exist in the name of the group.
name_exclude str
Match when the exact value does not exist in the name of the group.
name_prefix str
The name of the group must start with the value.
name_regexp str
The regular expression match of the name of the group.
name_suffix str
The name of the group must end with the value.
types Sequence[str]
Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.
groups List<Property Map>
List of Groups
id String
The ID of this resource.
isActive Boolean
Returns only Groups matching the specified state.
name String
Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
nameContains String
Match when the value exist in the name of the group.
nameExclude String
Match when the exact value does not exist in the name of the group.
namePrefix String
The name of the group must start with the value.
nameRegexp String
The regular expression match of the name of the group.
nameSuffix String
The name of the group must end with the value.
types List<String>
Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.

Supporting Types

GetTwingateGroupsGroup

Id This property is required. string
The ID of the Group
IsActive This property is required. bool
Indicates if the Group is active
Name This property is required. string
The name of the Group
SecurityPolicyId This property is required. string
The Security Policy assigned to the Group.
Type This property is required. string
The type of the Group
Id This property is required. string
The ID of the Group
IsActive This property is required. bool
Indicates if the Group is active
Name This property is required. string
The name of the Group
SecurityPolicyId This property is required. string
The Security Policy assigned to the Group.
Type This property is required. string
The type of the Group
id This property is required. String
The ID of the Group
isActive This property is required. Boolean
Indicates if the Group is active
name This property is required. String
The name of the Group
securityPolicyId This property is required. String
The Security Policy assigned to the Group.
type This property is required. String
The type of the Group
id This property is required. string
The ID of the Group
isActive This property is required. boolean
Indicates if the Group is active
name This property is required. string
The name of the Group
securityPolicyId This property is required. string
The Security Policy assigned to the Group.
type This property is required. string
The type of the Group
id This property is required. str
The ID of the Group
is_active This property is required. bool
Indicates if the Group is active
name This property is required. str
The name of the Group
security_policy_id This property is required. str
The Security Policy assigned to the Group.
type This property is required. str
The type of the Group
id This property is required. String
The ID of the Group
isActive This property is required. Boolean
Indicates if the Group is active
name This property is required. String
The name of the Group
securityPolicyId This property is required. String
The Security Policy assigned to the Group.
type This property is required. String
The type of the Group

Package Details

Repository
twingate Twingate/pulumi-twingate
License
Apache-2.0
Notes
This Pulumi package is based on the twingate Terraform Provider.
Twingate v3.0.18 published on Wednesday, Apr 16, 2025 by Twingate
twingate/pulumi-twingate