1. Packages
  2. Twingate
  3. API Docs
  4. getTwingateGroup
Twingate v3.0.1 published on Friday, Apr 19, 2024 by Twingate

twingate.getTwingateGroup

Explore with Pulumi AI

twingate logo
Twingate v3.0.1 published on Friday, Apr 19, 2024 by 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>",
    });
    
    import pulumi
    import pulumi_twingate as twingate
    
    foo = twingate.get_twingate_group(id="<your group's id>")
    
    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
    	})
    }
    
    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>",
        });
    
    });
    
    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());
    
        }
    }
    
    variables:
      foo:
        fn::invoke:
          Function: twingate:getTwingateGroup
          Arguments:
            id: <your group's id>
    

    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>
    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]
    func LookupTwingateGroup(ctx *Context, args *LookupTwingateGroupArgs, opts ...InvokeOption) (*LookupTwingateGroupResult, error)
    func LookupTwingateGroupOutput(ctx *Context, args *LookupTwingateGroupOutputArgs, opts ...InvokeOption) LookupTwingateGroupResultOutput

    > 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)
    }
    public static CompletableFuture<GetTwingateGroupResult> getTwingateGroup(GetTwingateGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: twingate:index/getTwingateGroup:getTwingateGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    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.
    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.
    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.
    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.
    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.
    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.

    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 logo
    Twingate v3.0.1 published on Friday, Apr 19, 2024 by Twingate