1. Packages
  2. Tailscale Provider
  3. API Docs
  4. getUser
Tailscale v0.19.0 published on Thursday, Apr 10, 2025 by Pulumi

tailscale.getUser

Explore with Pulumi AI

Tailscale v0.19.0 published on Thursday, Apr 10, 2025 by Pulumi

The user data source describes a single user in a tailnet

Using getUser

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 getUser(args: GetUserArgs, opts?: InvokeOptions): Promise<GetUserResult>
function getUserOutput(args: GetUserOutputArgs, opts?: InvokeOptions): Output<GetUserResult>
Copy
def get_user(id: Optional[str] = None,
             login_name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetUserResult
def get_user_output(id: Optional[pulumi.Input[str]] = None,
             login_name: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetUserResult]
Copy
func GetUser(ctx *Context, args *GetUserArgs, opts ...InvokeOption) (*GetUserResult, error)
func GetUserOutput(ctx *Context, args *GetUserOutputArgs, opts ...InvokeOption) GetUserResultOutput
Copy

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

public static class GetUser 
{
    public static Task<GetUserResult> InvokeAsync(GetUserArgs args, InvokeOptions? opts = null)
    public static Output<GetUserResult> Invoke(GetUserInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
public static Output<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: tailscale:index/getUser:getUser
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
The unique identifier for the user.
LoginName string
The emailish login name of the user.
Id string
The unique identifier for the user.
LoginName string
The emailish login name of the user.
id String
The unique identifier for the user.
loginName String
The emailish login name of the user.
id string
The unique identifier for the user.
loginName string
The emailish login name of the user.
id str
The unique identifier for the user.
login_name str
The emailish login name of the user.
id String
The unique identifier for the user.
loginName String
The emailish login name of the user.

getUser Result

The following output properties are available:

Created string
The time the user joined their tailnet.
CurrentlyConnected bool
true when the user has a node currently connected to the control server.
DeviceCount int
Number of devices the user owns.
DisplayName string
The name of the user.
LastSeen string
The later of either: a) The last time any of the user's nodes were connected to the network or b) The last time the user authenticated to any tailscale service, including the admin panel.
ProfilePicUrl string
The profile pic URL for the user.
Role string
The role of the user.
Status string
The status of the user.
TailnetId string
The tailnet that owns the user.
Type string
The type of relation this user has to the tailnet associated with the request.
Id string
The unique identifier for the user.
LoginName string
The emailish login name of the user.
Created string
The time the user joined their tailnet.
CurrentlyConnected bool
true when the user has a node currently connected to the control server.
DeviceCount int
Number of devices the user owns.
DisplayName string
The name of the user.
LastSeen string
The later of either: a) The last time any of the user's nodes were connected to the network or b) The last time the user authenticated to any tailscale service, including the admin panel.
ProfilePicUrl string
The profile pic URL for the user.
Role string
The role of the user.
Status string
The status of the user.
TailnetId string
The tailnet that owns the user.
Type string
The type of relation this user has to the tailnet associated with the request.
Id string
The unique identifier for the user.
LoginName string
The emailish login name of the user.
created String
The time the user joined their tailnet.
currentlyConnected Boolean
true when the user has a node currently connected to the control server.
deviceCount Integer
Number of devices the user owns.
displayName String
The name of the user.
lastSeen String
The later of either: a) The last time any of the user's nodes were connected to the network or b) The last time the user authenticated to any tailscale service, including the admin panel.
profilePicUrl String
The profile pic URL for the user.
role String
The role of the user.
status String
The status of the user.
tailnetId String
The tailnet that owns the user.
type String
The type of relation this user has to the tailnet associated with the request.
id String
The unique identifier for the user.
loginName String
The emailish login name of the user.
created string
The time the user joined their tailnet.
currentlyConnected boolean
true when the user has a node currently connected to the control server.
deviceCount number
Number of devices the user owns.
displayName string
The name of the user.
lastSeen string
The later of either: a) The last time any of the user's nodes were connected to the network or b) The last time the user authenticated to any tailscale service, including the admin panel.
profilePicUrl string
The profile pic URL for the user.
role string
The role of the user.
status string
The status of the user.
tailnetId string
The tailnet that owns the user.
type string
The type of relation this user has to the tailnet associated with the request.
id string
The unique identifier for the user.
loginName string
The emailish login name of the user.
created str
The time the user joined their tailnet.
currently_connected bool
true when the user has a node currently connected to the control server.
device_count int
Number of devices the user owns.
display_name str
The name of the user.
last_seen str
The later of either: a) The last time any of the user's nodes were connected to the network or b) The last time the user authenticated to any tailscale service, including the admin panel.
profile_pic_url str
The profile pic URL for the user.
role str
The role of the user.
status str
The status of the user.
tailnet_id str
The tailnet that owns the user.
type str
The type of relation this user has to the tailnet associated with the request.
id str
The unique identifier for the user.
login_name str
The emailish login name of the user.
created String
The time the user joined their tailnet.
currentlyConnected Boolean
true when the user has a node currently connected to the control server.
deviceCount Number
Number of devices the user owns.
displayName String
The name of the user.
lastSeen String
The later of either: a) The last time any of the user's nodes were connected to the network or b) The last time the user authenticated to any tailscale service, including the admin panel.
profilePicUrl String
The profile pic URL for the user.
role String
The role of the user.
status String
The status of the user.
tailnetId String
The tailnet that owns the user.
type String
The type of relation this user has to the tailnet associated with the request.
id String
The unique identifier for the user.
loginName String
The emailish login name of the user.

Package Details

Repository
tailscale pulumi/pulumi-tailscale
License
Apache-2.0
Notes
This Pulumi package is based on the tailscale Terraform Provider.
Tailscale v0.19.0 published on Thursday, Apr 10, 2025 by Pulumi