1. Packages
  2. Linode Provider
  3. API Docs
  4. getUser
Viewing docs for Linode v3.12.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
linode logo
Viewing docs for Linode v3.12.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    Provides information about a Linode user

    Example Usage

    The following example shows how one might use this data source to access information about a Linode user.

    using System.Collections.Generic;
    using Pulumi;
    using Linode = Pulumi.Linode;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = Linode.GetUser.Invoke(new()
        {
            Username = "foo",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-linode/sdk/v3/go/linode"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := linode.LookupUser(ctx, &linode.LookupUserArgs{
    			Username: "foo",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.linode.LinodeFunctions;
    import com.pulumi.linode.inputs.GetUserArgs;
    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 = LinodeFunctions.getUser(GetUserArgs.builder()
                .username("foo")
                .build());
    
        }
    }
    
    import * as pulumi from "@pulumi/pulumi";
    import * as linode from "@pulumi/linode";
    
    const foo = linode.getUser({
        username: "foo",
    });
    
    import pulumi
    import pulumi_linode as linode
    
    foo = linode.get_user(username="foo")
    
    variables:
      foo:
        fn::invoke:
          Function: linode:getUser
          Arguments:
            username: foo
    

    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>
    def get_user(domain_grants: Optional[Sequence[GetUserDomainGrant]] = None,
                 firewall_grants: Optional[Sequence[GetUserFirewallGrant]] = None,
                 image_grants: Optional[Sequence[GetUserImageGrant]] = None,
                 linode_grants: Optional[Sequence[GetUserLinodeGrant]] = None,
                 longview_grants: Optional[Sequence[GetUserLongviewGrant]] = None,
                 nodebalancer_grants: Optional[Sequence[GetUserNodebalancerGrant]] = None,
                 stackscript_grants: Optional[Sequence[GetUserStackscriptGrant]] = None,
                 username: Optional[str] = None,
                 volume_grants: Optional[Sequence[GetUserVolumeGrant]] = None,
                 opts: Optional[InvokeOptions] = None) -> GetUserResult
    def get_user_output(domain_grants: Optional[pulumi.Input[Sequence[pulumi.Input[GetUserDomainGrantArgs]]]] = None,
                 firewall_grants: Optional[pulumi.Input[Sequence[pulumi.Input[GetUserFirewallGrantArgs]]]] = None,
                 image_grants: Optional[pulumi.Input[Sequence[pulumi.Input[GetUserImageGrantArgs]]]] = None,
                 linode_grants: Optional[pulumi.Input[Sequence[pulumi.Input[GetUserLinodeGrantArgs]]]] = None,
                 longview_grants: Optional[pulumi.Input[Sequence[pulumi.Input[GetUserLongviewGrantArgs]]]] = None,
                 nodebalancer_grants: Optional[pulumi.Input[Sequence[pulumi.Input[GetUserNodebalancerGrantArgs]]]] = None,
                 stackscript_grants: Optional[pulumi.Input[Sequence[pulumi.Input[GetUserStackscriptGrantArgs]]]] = None,
                 username: Optional[pulumi.Input[str]] = None,
                 volume_grants: Optional[pulumi.Input[Sequence[pulumi.Input[GetUserVolumeGrantArgs]]]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetUserResult]
    func LookupUser(ctx *Context, args *LookupUserArgs, opts ...InvokeOption) (*LookupUserResult, error)
    func LookupUserOutput(ctx *Context, args *LookupUserOutputArgs, opts ...InvokeOption) LookupUserResultOutput

    > Note: This function is named LookupUser 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)
    }
    public static CompletableFuture<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
    public static Output<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
    
    fn::invoke:
      function: linode:index/getUser:getUser
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Username string
    The unique username of this User.
    DomainGrants List<GetUserDomainGrant>
    The grants this User has pertaining to Domains on this Account.
    FirewallGrants List<GetUserFirewallGrant>
    The grants this User has pertaining to Firewalls on this Account.
    ImageGrants List<GetUserImageGrant>
    The grants this User has pertaining to Images on this Account.
    LinodeGrants List<GetUserLinodeGrant>
    The grants this User has pertaining to Linodes on this Account.
    LongviewGrants List<GetUserLongviewGrant>
    The grants this User has pertaining to Longview Clients on this Account.
    NodebalancerGrants List<GetUserNodebalancerGrant>
    The grants this User has pertaining to NodeBalancers on this Account.
    StackscriptGrants List<GetUserStackscriptGrant>
    The grants this User has pertaining to StackScripts on this Account.
    VolumeGrants List<GetUserVolumeGrant>
    The grants this User has pertaining to Volumes on this Account.
    Username string
    The unique username of this User.
    DomainGrants []GetUserDomainGrant
    The grants this User has pertaining to Domains on this Account.
    FirewallGrants []GetUserFirewallGrant
    The grants this User has pertaining to Firewalls on this Account.
    ImageGrants []GetUserImageGrant
    The grants this User has pertaining to Images on this Account.
    LinodeGrants []GetUserLinodeGrant
    The grants this User has pertaining to Linodes on this Account.
    LongviewGrants []GetUserLongviewGrant
    The grants this User has pertaining to Longview Clients on this Account.
    NodebalancerGrants []GetUserNodebalancerGrant
    The grants this User has pertaining to NodeBalancers on this Account.
    StackscriptGrants []GetUserStackscriptGrant
    The grants this User has pertaining to StackScripts on this Account.
    VolumeGrants []GetUserVolumeGrant
    The grants this User has pertaining to Volumes on this Account.
    username String
    The unique username of this User.
    domainGrants List<GetUserDomainGrant>
    The grants this User has pertaining to Domains on this Account.
    firewallGrants List<GetUserFirewallGrant>
    The grants this User has pertaining to Firewalls on this Account.
    imageGrants List<GetUserImageGrant>
    The grants this User has pertaining to Images on this Account.
    linodeGrants List<GetUserLinodeGrant>
    The grants this User has pertaining to Linodes on this Account.
    longviewGrants List<GetUserLongviewGrant>
    The grants this User has pertaining to Longview Clients on this Account.
    nodebalancerGrants List<GetUserNodebalancerGrant>
    The grants this User has pertaining to NodeBalancers on this Account.
    stackscriptGrants List<GetUserStackscriptGrant>
    The grants this User has pertaining to StackScripts on this Account.
    volumeGrants List<GetUserVolumeGrant>
    The grants this User has pertaining to Volumes on this Account.
    username string
    The unique username of this User.
    domainGrants GetUserDomainGrant[]
    The grants this User has pertaining to Domains on this Account.
    firewallGrants GetUserFirewallGrant[]
    The grants this User has pertaining to Firewalls on this Account.
    imageGrants GetUserImageGrant[]
    The grants this User has pertaining to Images on this Account.
    linodeGrants GetUserLinodeGrant[]
    The grants this User has pertaining to Linodes on this Account.
    longviewGrants GetUserLongviewGrant[]
    The grants this User has pertaining to Longview Clients on this Account.
    nodebalancerGrants GetUserNodebalancerGrant[]
    The grants this User has pertaining to NodeBalancers on this Account.
    stackscriptGrants GetUserStackscriptGrant[]
    The grants this User has pertaining to StackScripts on this Account.
    volumeGrants GetUserVolumeGrant[]
    The grants this User has pertaining to Volumes on this Account.
    username str
    The unique username of this User.
    domain_grants Sequence[GetUserDomainGrant]
    The grants this User has pertaining to Domains on this Account.
    firewall_grants Sequence[GetUserFirewallGrant]
    The grants this User has pertaining to Firewalls on this Account.
    image_grants Sequence[GetUserImageGrant]
    The grants this User has pertaining to Images on this Account.
    linode_grants Sequence[GetUserLinodeGrant]
    The grants this User has pertaining to Linodes on this Account.
    longview_grants Sequence[GetUserLongviewGrant]
    The grants this User has pertaining to Longview Clients on this Account.
    nodebalancer_grants Sequence[GetUserNodebalancerGrant]
    The grants this User has pertaining to NodeBalancers on this Account.
    stackscript_grants Sequence[GetUserStackscriptGrant]
    The grants this User has pertaining to StackScripts on this Account.
    volume_grants Sequence[GetUserVolumeGrant]
    The grants this User has pertaining to Volumes on this Account.
    username String
    The unique username of this User.
    domainGrants List<Property Map>
    The grants this User has pertaining to Domains on this Account.
    firewallGrants List<Property Map>
    The grants this User has pertaining to Firewalls on this Account.
    imageGrants List<Property Map>
    The grants this User has pertaining to Images on this Account.
    linodeGrants List<Property Map>
    The grants this User has pertaining to Linodes on this Account.
    longviewGrants List<Property Map>
    The grants this User has pertaining to Longview Clients on this Account.
    nodebalancerGrants List<Property Map>
    The grants this User has pertaining to NodeBalancers on this Account.
    stackscriptGrants List<Property Map>
    The grants this User has pertaining to StackScripts on this Account.
    volumeGrants List<Property Map>
    The grants this User has pertaining to Volumes on this Account.

    getUser Result

    The following output properties are available:

    DomainGrants List<GetUserDomainGrant>
    The grants this User has pertaining to Domains on this Account.
    Email string
    The email address for this User, for account management communications, and may be used for other communications as configured.
    FirewallGrants List<GetUserFirewallGrant>
    The grants this User has pertaining to Firewalls on this Account.
    GlobalGrants List<GetUserGlobalGrant>
    The Account-level grants a User has.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageGrants List<GetUserImageGrant>
    The grants this User has pertaining to Images on this Account.
    LinodeGrants List<GetUserLinodeGrant>
    The grants this User has pertaining to Linodes on this Account.
    LongviewGrants List<GetUserLongviewGrant>
    The grants this User has pertaining to Longview Clients on this Account.
    NodebalancerGrants List<GetUserNodebalancerGrant>
    The grants this User has pertaining to NodeBalancers on this Account.
    Restricted bool
    If true, this User must be granted access to perform actions or access entities on this Account.
    SshKeys List<string>
    A list of SSH Key labels added by this User. These are the keys that will be deployed if this User is included in the authorized_users field of a create Linode, rebuild Linode, or create Disk request.
    StackscriptGrants List<GetUserStackscriptGrant>
    The grants this User has pertaining to StackScripts on this Account.
    Username string
    VolumeGrants List<GetUserVolumeGrant>
    The grants this User has pertaining to Volumes on this Account.
    DomainGrants []GetUserDomainGrant
    The grants this User has pertaining to Domains on this Account.
    Email string
    The email address for this User, for account management communications, and may be used for other communications as configured.
    FirewallGrants []GetUserFirewallGrant
    The grants this User has pertaining to Firewalls on this Account.
    GlobalGrants []GetUserGlobalGrant
    The Account-level grants a User has.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageGrants []GetUserImageGrant
    The grants this User has pertaining to Images on this Account.
    LinodeGrants []GetUserLinodeGrant
    The grants this User has pertaining to Linodes on this Account.
    LongviewGrants []GetUserLongviewGrant
    The grants this User has pertaining to Longview Clients on this Account.
    NodebalancerGrants []GetUserNodebalancerGrant
    The grants this User has pertaining to NodeBalancers on this Account.
    Restricted bool
    If true, this User must be granted access to perform actions or access entities on this Account.
    SshKeys []string
    A list of SSH Key labels added by this User. These are the keys that will be deployed if this User is included in the authorized_users field of a create Linode, rebuild Linode, or create Disk request.
    StackscriptGrants []GetUserStackscriptGrant
    The grants this User has pertaining to StackScripts on this Account.
    Username string
    VolumeGrants []GetUserVolumeGrant
    The grants this User has pertaining to Volumes on this Account.
    domainGrants List<GetUserDomainGrant>
    The grants this User has pertaining to Domains on this Account.
    email String
    The email address for this User, for account management communications, and may be used for other communications as configured.
    firewallGrants List<GetUserFirewallGrant>
    The grants this User has pertaining to Firewalls on this Account.
    globalGrants List<GetUserGlobalGrant>
    The Account-level grants a User has.
    id String
    The provider-assigned unique ID for this managed resource.
    imageGrants List<GetUserImageGrant>
    The grants this User has pertaining to Images on this Account.
    linodeGrants List<GetUserLinodeGrant>
    The grants this User has pertaining to Linodes on this Account.
    longviewGrants List<GetUserLongviewGrant>
    The grants this User has pertaining to Longview Clients on this Account.
    nodebalancerGrants List<GetUserNodebalancerGrant>
    The grants this User has pertaining to NodeBalancers on this Account.
    restricted Boolean
    If true, this User must be granted access to perform actions or access entities on this Account.
    sshKeys List<String>
    A list of SSH Key labels added by this User. These are the keys that will be deployed if this User is included in the authorized_users field of a create Linode, rebuild Linode, or create Disk request.
    stackscriptGrants List<GetUserStackscriptGrant>
    The grants this User has pertaining to StackScripts on this Account.
    username String
    volumeGrants List<GetUserVolumeGrant>
    The grants this User has pertaining to Volumes on this Account.
    domainGrants GetUserDomainGrant[]
    The grants this User has pertaining to Domains on this Account.
    email string
    The email address for this User, for account management communications, and may be used for other communications as configured.
    firewallGrants GetUserFirewallGrant[]
    The grants this User has pertaining to Firewalls on this Account.
    globalGrants GetUserGlobalGrant[]
    The Account-level grants a User has.
    id string
    The provider-assigned unique ID for this managed resource.
    imageGrants GetUserImageGrant[]
    The grants this User has pertaining to Images on this Account.
    linodeGrants GetUserLinodeGrant[]
    The grants this User has pertaining to Linodes on this Account.
    longviewGrants GetUserLongviewGrant[]
    The grants this User has pertaining to Longview Clients on this Account.
    nodebalancerGrants GetUserNodebalancerGrant[]
    The grants this User has pertaining to NodeBalancers on this Account.
    restricted boolean
    If true, this User must be granted access to perform actions or access entities on this Account.
    sshKeys string[]
    A list of SSH Key labels added by this User. These are the keys that will be deployed if this User is included in the authorized_users field of a create Linode, rebuild Linode, or create Disk request.
    stackscriptGrants GetUserStackscriptGrant[]
    The grants this User has pertaining to StackScripts on this Account.
    username string
    volumeGrants GetUserVolumeGrant[]
    The grants this User has pertaining to Volumes on this Account.
    domain_grants Sequence[GetUserDomainGrant]
    The grants this User has pertaining to Domains on this Account.
    email str
    The email address for this User, for account management communications, and may be used for other communications as configured.
    firewall_grants Sequence[GetUserFirewallGrant]
    The grants this User has pertaining to Firewalls on this Account.
    global_grants Sequence[GetUserGlobalGrant]
    The Account-level grants a User has.
    id str
    The provider-assigned unique ID for this managed resource.
    image_grants Sequence[GetUserImageGrant]
    The grants this User has pertaining to Images on this Account.
    linode_grants Sequence[GetUserLinodeGrant]
    The grants this User has pertaining to Linodes on this Account.
    longview_grants Sequence[GetUserLongviewGrant]
    The grants this User has pertaining to Longview Clients on this Account.
    nodebalancer_grants Sequence[GetUserNodebalancerGrant]
    The grants this User has pertaining to NodeBalancers on this Account.
    restricted bool
    If true, this User must be granted access to perform actions or access entities on this Account.
    ssh_keys Sequence[str]
    A list of SSH Key labels added by this User. These are the keys that will be deployed if this User is included in the authorized_users field of a create Linode, rebuild Linode, or create Disk request.
    stackscript_grants Sequence[GetUserStackscriptGrant]
    The grants this User has pertaining to StackScripts on this Account.
    username str
    volume_grants Sequence[GetUserVolumeGrant]
    The grants this User has pertaining to Volumes on this Account.
    domainGrants List<Property Map>
    The grants this User has pertaining to Domains on this Account.
    email String
    The email address for this User, for account management communications, and may be used for other communications as configured.
    firewallGrants List<Property Map>
    The grants this User has pertaining to Firewalls on this Account.
    globalGrants List<Property Map>
    The Account-level grants a User has.
    id String
    The provider-assigned unique ID for this managed resource.
    imageGrants List<Property Map>
    The grants this User has pertaining to Images on this Account.
    linodeGrants List<Property Map>
    The grants this User has pertaining to Linodes on this Account.
    longviewGrants List<Property Map>
    The grants this User has pertaining to Longview Clients on this Account.
    nodebalancerGrants List<Property Map>
    The grants this User has pertaining to NodeBalancers on this Account.
    restricted Boolean
    If true, this User must be granted access to perform actions or access entities on this Account.
    sshKeys List<String>
    A list of SSH Key labels added by this User. These are the keys that will be deployed if this User is included in the authorized_users field of a create Linode, rebuild Linode, or create Disk request.
    stackscriptGrants List<Property Map>
    The grants this User has pertaining to StackScripts on this Account.
    username String
    volumeGrants List<Property Map>
    The grants this User has pertaining to Volumes on this Account.

    Supporting Types

    GetUserDomainGrant

    Id int
    Permissions string
    Id int
    Permissions string
    id Integer
    permissions String
    id number
    permissions string
    id Number
    permissions String

    GetUserFirewallGrant

    Id int
    Permissions string
    Id int
    Permissions string
    id Integer
    permissions String
    id number
    permissions string
    id Number
    permissions String

    GetUserGlobalGrant

    GetUserImageGrant

    Id int
    Permissions string
    Id int
    Permissions string
    id Integer
    permissions String
    id number
    permissions string
    id Number
    permissions String

    GetUserLinodeGrant

    Id int
    Permissions string
    Id int
    Permissions string
    id Integer
    permissions String
    id number
    permissions string
    id Number
    permissions String

    GetUserLongviewGrant

    Id int
    Permissions string
    Id int
    Permissions string
    id Integer
    permissions String
    id number
    permissions string
    id Number
    permissions String

    GetUserNodebalancerGrant

    Id int
    Permissions string
    Id int
    Permissions string
    id Integer
    permissions String
    id number
    permissions string
    id Number
    permissions String

    GetUserStackscriptGrant

    Id int
    Permissions string
    Id int
    Permissions string
    id Integer
    permissions String
    id number
    permissions string
    id Number
    permissions String

    GetUserVolumeGrant

    Id int
    Permissions string
    Id int
    Permissions string
    id Integer
    permissions String
    id number
    permissions string
    id Number
    permissions String

    Package Details

    Repository
    Linode pulumi/pulumi-linode
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the linode Terraform Provider.
    linode logo
    Viewing docs for Linode v3.12.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.