Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Twingate
  3. API Docs
  4. getTwingateUser
Twingate v3.0.12 published on Tuesday, Nov 5, 2024 by Twingate
Twingate/pulumi-twingate

twingate.getTwingateUser

Explore with Pulumi AI

twingate logo
Twingate v3.0.12 published on Tuesday, Nov 5, 2024 by Twingate
Twingate/pulumi-twingate

    Users in Twingate can be given access to Twingate Resources and may either be added manually or automatically synchronized with a 3rd party identity provider. For more information, see Twingate’s documentation.

    Example Usage

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

const foo = twingate.getTwingateUser({
    id: "<your user's id>",
});

    import pulumi
import pulumi_twingate as twingate

foo = twingate.get_twingate_user(id="<your user'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.LookupTwingateUser(ctx, &twingate.LookupTwingateUserArgs{
			Id: "<your user'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.GetTwingateUser.Invoke(new()
    {
        Id = "<your user'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.GetTwingateUserArgs;
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.getTwingateUser(GetTwingateUserArgs.builder()
            .id("<your user's id>")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: twingate:getTwingateUser
      Arguments:
        id: <your user's id>

    Using getTwingateUser

    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 getTwingateUser(args: GetTwingateUserArgs, opts?: InvokeOptions): Promise<GetTwingateUserResult>
function getTwingateUserOutput(args: GetTwingateUserOutputArgs, opts?: InvokeOptions): Output<GetTwingateUserResult>
    def get_twingate_user(id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetTwingateUserResult
def get_twingate_user_output(id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetTwingateUserResult]
    func LookupTwingateUser(ctx *Context, args *LookupTwingateUserArgs, opts ...InvokeOption) (*LookupTwingateUserResult, error)
func LookupTwingateUserOutput(ctx *Context, args *LookupTwingateUserOutputArgs, opts ...InvokeOption) LookupTwingateUserResultOutput

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

    public static class GetTwingateUser 
{
    public static Task<GetTwingateUserResult> InvokeAsync(GetTwingateUserArgs args, InvokeOptions? opts = null)
    public static Output<GetTwingateUserResult> Invoke(GetTwingateUserInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTwingateUserResult> getTwingateUser(GetTwingateUserArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: twingate:index/getTwingateUser:getTwingateUser
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of the User. The ID for the User can be obtained from the Admin API or the URL string in the Admin Console.
    Id string
    The ID of the User. The ID for the User can be obtained from the Admin API or the URL string in the Admin Console.
    id String
    The ID of the User. The ID for the User can be obtained from the Admin API or the URL string in the Admin Console.
    id string
    The ID of the User. The ID for the User can be obtained from the Admin API or the URL string in the Admin Console.
    id str
    The ID of the User. The ID for the User can be obtained from the Admin API or the URL string in the Admin Console.
    id String
    The ID of the User. The ID for the User can be obtained from the Admin API or the URL string in the Admin Console.

    getTwingateUser Result

    The following output properties are available:

    Email string
    The email address of the User
    FirstName string
    The first name of the User
    Id string
    The ID of the User. The ID for the User can be obtained from the Admin API or the URL string in the Admin Console.
    LastName string
    The last name of the User
    Role string
    Indicates the User's role. Either ADMIN, DEVOPS, SUPPORT, or MEMBER
    Type string
    Indicates the User's type. Either MANUAL or SYNCED.
    Email string
    The email address of the User
    FirstName string
    The first name of the User
    Id string
    The ID of the User. The ID for the User can be obtained from the Admin API or the URL string in the Admin Console.
    LastName string
    The last name of the User
    Role string
    Indicates the User's role. Either ADMIN, DEVOPS, SUPPORT, or MEMBER
    Type string
    Indicates the User's type. Either MANUAL or SYNCED.
    email String
    The email address of the User
    firstName String
    The first name of the User
    id String
    The ID of the User. The ID for the User can be obtained from the Admin API or the URL string in the Admin Console.
    lastName String
    The last name of the User
    role String
    Indicates the User's role. Either ADMIN, DEVOPS, SUPPORT, or MEMBER
    type String
    Indicates the User's type. Either MANUAL or SYNCED.
    email string
    The email address of the User
    firstName string
    The first name of the User
    id string
    The ID of the User. The ID for the User can be obtained from the Admin API or the URL string in the Admin Console.
    lastName string
    The last name of the User
    role string
    Indicates the User's role. Either ADMIN, DEVOPS, SUPPORT, or MEMBER
    type string
    Indicates the User's type. Either MANUAL or SYNCED.
    email str
    The email address of the User
    first_name str
    The first name of the User
    id str
    The ID of the User. The ID for the User can be obtained from the Admin API or the URL string in the Admin Console.
    last_name str
    The last name of the User
    role str
    Indicates the User's role. Either ADMIN, DEVOPS, SUPPORT, or MEMBER
    type str
    Indicates the User's type. Either MANUAL or SYNCED.
    email String
    The email address of the User
    firstName String
    The first name of the User
    id String
    The ID of the User. The ID for the User can be obtained from the Admin API or the URL string in the Admin Console.
    lastName String
    The last name of the User
    role String
    Indicates the User's role. Either ADMIN, DEVOPS, SUPPORT, or MEMBER
    type String
    Indicates the User's type. Either MANUAL or SYNCED.

    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.12 published on Tuesday, Nov 5, 2024 by Twingate
    Twingate/pulumi-twingate