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

twingate.getTwingateGroup

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.getTwingateGroup({
    id: "<your group's id>",
});
Copy
import pulumi
import pulumi_twingate as twingate

foo = twingate.get_twingate_group(id="<your group's id>")
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.LookupTwingateGroup(ctx, &twingate.LookupTwingateGroupArgs{
			Id: "<your group's id>",
		}, 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.GetTwingateGroup.Invoke(new()
    {
        Id = "<your group's id>",
    });

});
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.GetTwingateGroupArgs;
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.getTwingateGroup(GetTwingateGroupArgs.builder()
            .id("<your group's id>")
            .build());

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

Using getTwingateGroup

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 getTwingateGroup(args: GetTwingateGroupArgs, opts?: InvokeOptions): Promise<GetTwingateGroupResult>
function getTwingateGroupOutput(args: GetTwingateGroupOutputArgs, opts?: InvokeOptions): Output<GetTwingateGroupResult>
Copy
def get_twingate_group(id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetTwingateGroupResult
def get_twingate_group_output(id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetTwingateGroupResult]
Copy
func LookupTwingateGroup(ctx *Context, args *LookupTwingateGroupArgs, opts ...InvokeOption) (*LookupTwingateGroupResult, error)
func LookupTwingateGroupOutput(ctx *Context, args *LookupTwingateGroupOutputArgs, opts ...InvokeOption) LookupTwingateGroupResultOutput
Copy

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

public static class GetTwingateGroup 
{
    public static Task<GetTwingateGroupResult> InvokeAsync(GetTwingateGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetTwingateGroupResult> Invoke(GetTwingateGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTwingateGroupResult> getTwingateGroup(GetTwingateGroupArgs args, InvokeOptions options)
public static Output<GetTwingateGroupResult> getTwingateGroup(GetTwingateGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: twingate:index/getTwingateGroup:getTwingateGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The ID of the Group. The ID for the Group can be obtained from the Admin API or the URL string in the Admin Console.
Id This property is required. string
The ID of the Group. The ID for the Group can be obtained from the Admin API or the URL string in the Admin Console.
id This property is required. String
The ID of the Group. The ID for the Group can be obtained from the Admin API or the URL string in the Admin Console.
id This property is required. string
The ID of the Group. The ID for the Group can be obtained from the Admin API or the URL string in the Admin Console.
id This property is required. str
The ID of the Group. The ID for the Group can be obtained from the Admin API or the URL string in the Admin Console.
id This property is required. String
The ID of the Group. The ID for the Group can be obtained from the Admin API or the URL string in the Admin Console.

getTwingateGroup Result

The following output properties are available:

Id string
The ID of the Group. The ID for the Group can be obtained from the Admin API or the URL string in the Admin Console.
IsActive bool
Indicates if the Group is active
Name string
The name of the Group
SecurityPolicyId string
The Security Policy assigned to the Group.
Type string
The type of the Group
Id string
The ID of the Group. The ID for the Group can be obtained from the Admin API or the URL string in the Admin Console.
IsActive bool
Indicates if the Group is active
Name string
The name of the Group
SecurityPolicyId string
The Security Policy assigned to the Group.
Type string
The type of the Group
id String
The ID of the Group. The ID for the Group can be obtained from the Admin API or the URL string in the Admin Console.
isActive Boolean
Indicates if the Group is active
name String
The name of the Group
securityPolicyId String
The Security Policy assigned to the Group.
type String
The type of the Group
id string
The ID of the Group. The ID for the Group can be obtained from the Admin API or the URL string in the Admin Console.
isActive boolean
Indicates if the Group is active
name string
The name of the Group
securityPolicyId string
The Security Policy assigned to the Group.
type string
The type of the Group
id str
The ID of the Group. The ID for the Group can be obtained from the Admin API or the URL string in the Admin Console.
is_active bool
Indicates if the Group is active
name str
The name of the Group
security_policy_id str
The Security Policy assigned to the Group.
type str
The type of the Group
id String
The ID of the Group. The ID for the Group can be obtained from the Admin API or the URL string in the Admin Console.
isActive Boolean
Indicates if the Group is active
name String
The name of the Group
securityPolicyId String
The Security Policy assigned to the Group.
type 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