1. Packages
  2. Nutanix
  3. API Docs
  4. getUser
Viewing docs for Nutanix v0.11.0
published on Monday, Nov 24, 2025 by Piers Karsenbarg
Schema (JSON)
pierskarsenbarg/pulumi-nutanix

nutanix.getUser

nutanix logo
Viewing docs for Nutanix v0.11.0
published on Monday, Nov 24, 2025 by Piers Karsenbarg
Schema (JSON)
pierskarsenbarg/pulumi-nutanix

    Provides a datasource to retrieve a user based on the input parameters.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as nutanix from "@pierskarsenbarg/nutanix";

const userUser = new nutanix.User("user", {directoryServiceUser: {
    userPrincipalName: "test-user@ntnxlab.local",
    directoryServiceReference: {
        uuid: "<directory-service-uuid>",
    },
}});
//Retrieve by UUID
const user = nutanix.getUserOutput({
    userId: userUser.id,
});
//Retrieve by Name
const userbyname = nutanix.getUserOutput({
    userName: userUser.name,
});

    import pulumi
import pulumi_nutanix as nutanix

user_user = nutanix.User("user", directory_service_user={
    "user_principal_name": "test-user@ntnxlab.local",
    "directory_service_reference": {
        "uuid": "<directory-service-uuid>",
    },
})
#Retrieve by UUID
user = nutanix.get_user_output(user_id=user_user.id)
#Retrieve by Name
userbyname = nutanix.get_user_output(user_name=user_user.name)

    package main

import (
	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		userUser, err := nutanix.NewUser(ctx, "user", &nutanix.UserArgs{
			DirectoryServiceUser: &nutanix.UserDirectoryServiceUserArgs{
				UserPrincipalName: pulumi.String("test-user@ntnxlab.local"),
				DirectoryServiceReference: &nutanix.UserDirectoryServiceUserDirectoryServiceReferenceArgs{
					Uuid: pulumi.String("<directory-service-uuid>"),
				},
			},
		})
		if err != nil {
			return err
		}
		// Retrieve by UUID
		_ = nutanix.LookupUserOutput(ctx, nutanix.GetUserOutputArgs{
			UserId: userUser.ID(),
		}, nil)
		// Retrieve by Name
		_ = nutanix.LookupUserOutput(ctx, nutanix.GetUserOutputArgs{
			UserName: userUser.Name,
		}, nil)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nutanix = PiersKarsenbarg.Nutanix;
using Nutanix = Pulumi.Nutanix;

return await Deployment.RunAsync(() => 
{
    var userUser = new Nutanix.User("user", new()
    {
        DirectoryServiceUser = new Nutanix.Inputs.UserDirectoryServiceUserArgs
        {
            UserPrincipalName = "test-user@ntnxlab.local",
            DirectoryServiceReference = new Nutanix.Inputs.UserDirectoryServiceUserDirectoryServiceReferenceArgs
            {
                Uuid = "<directory-service-uuid>",
            },
        },
    });

    //Retrieve by UUID
    var user = Nutanix.GetUser.Invoke(new()
    {
        UserId = userUser.Id,
    });

    //Retrieve by Name
    var userbyname = Nutanix.GetUser.Invoke(new()
    {
        UserName = userUser.Name,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.User;
import com.pulumi.nutanix.UserArgs;
import com.pulumi.nutanix.inputs.UserDirectoryServiceUserArgs;
import com.pulumi.nutanix.inputs.UserDirectoryServiceUserDirectoryServiceReferenceArgs;
import com.pulumi.nutanix.NutanixFunctions;
import com.pulumi.nutanix.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) {
        var userUser = new User("userUser", UserArgs.builder()
            .directoryServiceUser(UserDirectoryServiceUserArgs.builder()
                .userPrincipalName("test-user@ntnxlab.local")
                .directoryServiceReference(UserDirectoryServiceUserDirectoryServiceReferenceArgs.builder()
                    .uuid("<directory-service-uuid>")
                    .build())
                .build())
            .build());

        //Retrieve by UUID
        final var user = NutanixFunctions.getUser(GetUserArgs.builder()
            .userId(userUser.id())
            .build());

        //Retrieve by Name
        final var userbyname = NutanixFunctions.getUser(GetUserArgs.builder()
            .userName(userUser.name())
            .build());

    }
}

    resources:
  userUser:
    type: nutanix:User
    name: user
    properties:
      directoryServiceUser:
        userPrincipalName: test-user@ntnxlab.local
        directoryServiceReference:
          uuid: <directory-service-uuid>
variables:
  # Retrieve by UUID
  user:
    fn::invoke:
      function: nutanix:getUser
      arguments:
        userId: ${userUser.id}
  # Retrieve by Name
  userbyname:
    fn::invoke:
      function: nutanix:getUser
      arguments:
        userName: ${userUser.name}

    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(categories: Optional[Sequence[GetUserCategory]] = None,
             owner_reference: Optional[Mapping[str, str]] = None,
             project_reference: Optional[Mapping[str, str]] = None,
             user_id: Optional[str] = None,
             user_name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetUserResult
def get_user_output(categories: Optional[pulumi.Input[Sequence[pulumi.Input[GetUserCategoryArgs]]]] = None,
             owner_reference: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
             project_reference: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
             user_id: Optional[pulumi.Input[str]] = None,
             user_name: Optional[pulumi.Input[str]] = 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: nutanix:index/getUser:getUser
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Categories List<PiersKarsenbarg.Nutanix.Inputs.GetUserCategory>
    • (Optional) Categories for the Access Control Policy.
    OwnerReference Dictionary<string, string>
    • (Optional) The reference to a user.
    ProjectReference Dictionary<string, string>
    • (Optional) The reference to a project.
    UserId string
    UserName string
    Categories []GetUserCategory
    • (Optional) Categories for the Access Control Policy.
    OwnerReference map[string]string
    • (Optional) The reference to a user.
    ProjectReference map[string]string
    • (Optional) The reference to a project.
    UserId string
    UserName string
    categories List<GetUserCategory>
    • (Optional) Categories for the Access Control Policy.
    ownerReference Map<String,String>
    • (Optional) The reference to a user.
    projectReference Map<String,String>
    • (Optional) The reference to a project.
    userId String
    userName String
    categories GetUserCategory[]
    • (Optional) Categories for the Access Control Policy.
    ownerReference {[key: string]: string}
    • (Optional) The reference to a user.
    projectReference {[key: string]: string}
    • (Optional) The reference to a project.
    userId string
    userName string
    categories Sequence[GetUserCategory]
    • (Optional) Categories for the Access Control Policy.
    owner_reference Mapping[str, str]
    • (Optional) The reference to a user.
    project_reference Mapping[str, str]
    • (Optional) The reference to a project.
    user_id str
    user_name str
    categories List<Property Map>
    • (Optional) Categories for the Access Control Policy.
    ownerReference Map<String>
    • (Optional) The reference to a user.
    projectReference Map<String>
    • (Optional) The reference to a project.
    userId String
    userName String

    getUser Result

    The following output properties are available:

    AccessControlPolicyReferenceLists List<PiersKarsenbarg.Nutanix.Outputs.GetUserAccessControlPolicyReferenceList>
    • List of ACP references. See #reference for more details.
    ApiVersion string
    The version of the API.
    Categories List<PiersKarsenbarg.Nutanix.Outputs.GetUserCategory>
    • (Optional) Categories for the Access Control Policy.
    DirectoryServiceUsers List<PiersKarsenbarg.Nutanix.Outputs.GetUserDirectoryServiceUser>
    • (Optional) The directory service user configuration. See below for more information.
    DisplayName string
    • The display name of the user (common name) provided by the directory service.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityProviderUsers List<PiersKarsenbarg.Nutanix.Outputs.GetUserIdentityProviderUser>
    • (Optional) (Optional) The identity provider user configuration. See below for more information.
    Metadata Dictionary<string, string>
    • The user kind metadata.
    OwnerReference Dictionary<string, string>
    • (Optional) The reference to a user.
    ProjectReferenceLists List<PiersKarsenbarg.Nutanix.Outputs.GetUserProjectReferenceList>
    • A list of projects the user is part of. See #reference for more details.
    State string
    • The state of the entity.
    UserType string
    • The name of the user.
    ProjectReference Dictionary<string, string>
    • (Optional) The reference to a project.
    UserId string
    UserName string
    AccessControlPolicyReferenceLists []GetUserAccessControlPolicyReferenceList
    • List of ACP references. See #reference for more details.
    ApiVersion string
    The version of the API.
    Categories []GetUserCategory
    • (Optional) Categories for the Access Control Policy.
    DirectoryServiceUsers []GetUserDirectoryServiceUser
    • (Optional) The directory service user configuration. See below for more information.
    DisplayName string
    • The display name of the user (common name) provided by the directory service.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityProviderUsers []GetUserIdentityProviderUser
    • (Optional) (Optional) The identity provider user configuration. See below for more information.
    Metadata map[string]string
    • The user kind metadata.
    OwnerReference map[string]string
    • (Optional) The reference to a user.
    ProjectReferenceLists []GetUserProjectReferenceList
    • A list of projects the user is part of. See #reference for more details.
    State string
    • The state of the entity.
    UserType string
    • The name of the user.
    ProjectReference map[string]string
    • (Optional) The reference to a project.
    UserId string
    UserName string
    accessControlPolicyReferenceLists List<GetUserAccessControlPolicyReferenceList>
    • List of ACP references. See #reference for more details.
    apiVersion String
    The version of the API.
    categories List<GetUserCategory>
    • (Optional) Categories for the Access Control Policy.
    directoryServiceUsers List<GetUserDirectoryServiceUser>
    • (Optional) The directory service user configuration. See below for more information.
    displayName String
    • The display name of the user (common name) provided by the directory service.
    id String
    The provider-assigned unique ID for this managed resource.
    identityProviderUsers List<GetUserIdentityProviderUser>
    • (Optional) (Optional) The identity provider user configuration. See below for more information.
    metadata Map<String,String>
    • The user kind metadata.
    ownerReference Map<String,String>
    • (Optional) The reference to a user.
    projectReferenceLists List<GetUserProjectReferenceList>
    • A list of projects the user is part of. See #reference for more details.
    state String
    • The state of the entity.
    userType String
    • The name of the user.
    projectReference Map<String,String>
    • (Optional) The reference to a project.
    userId String
    userName String
    accessControlPolicyReferenceLists GetUserAccessControlPolicyReferenceList[]
    • List of ACP references. See #reference for more details.
    apiVersion string
    The version of the API.
    categories GetUserCategory[]
    • (Optional) Categories for the Access Control Policy.
    directoryServiceUsers GetUserDirectoryServiceUser[]
    • (Optional) The directory service user configuration. See below for more information.
    displayName string
    • The display name of the user (common name) provided by the directory service.
    id string
    The provider-assigned unique ID for this managed resource.
    identityProviderUsers GetUserIdentityProviderUser[]
    • (Optional) (Optional) The identity provider user configuration. See below for more information.
    metadata {[key: string]: string}
    • The user kind metadata.
    ownerReference {[key: string]: string}
    • (Optional) The reference to a user.
    projectReferenceLists GetUserProjectReferenceList[]
    • A list of projects the user is part of. See #reference for more details.
    state string
    • The state of the entity.
    userType string
    • The name of the user.
    projectReference {[key: string]: string}
    • (Optional) The reference to a project.
    userId string
    userName string
    access_control_policy_reference_lists Sequence[GetUserAccessControlPolicyReferenceList]
    • List of ACP references. See #reference for more details.
    api_version str
    The version of the API.
    categories Sequence[GetUserCategory]
    • (Optional) Categories for the Access Control Policy.
    directory_service_users Sequence[GetUserDirectoryServiceUser]
    • (Optional) The directory service user configuration. See below for more information.
    display_name str
    • The display name of the user (common name) provided by the directory service.
    id str
    The provider-assigned unique ID for this managed resource.
    identity_provider_users Sequence[GetUserIdentityProviderUser]
    • (Optional) (Optional) The identity provider user configuration. See below for more information.
    metadata Mapping[str, str]
    • The user kind metadata.
    owner_reference Mapping[str, str]
    • (Optional) The reference to a user.
    project_reference_lists Sequence[GetUserProjectReferenceList]
    • A list of projects the user is part of. See #reference for more details.
    state str
    • The state of the entity.
    user_type str
    • The name of the user.
    project_reference Mapping[str, str]
    • (Optional) The reference to a project.
    user_id str
    user_name str
    accessControlPolicyReferenceLists List<Property Map>
    • List of ACP references. See #reference for more details.
    apiVersion String
    The version of the API.
    categories List<Property Map>
    • (Optional) Categories for the Access Control Policy.
    directoryServiceUsers List<Property Map>
    • (Optional) The directory service user configuration. See below for more information.
    displayName String
    • The display name of the user (common name) provided by the directory service.
    id String
    The provider-assigned unique ID for this managed resource.
    identityProviderUsers List<Property Map>
    • (Optional) (Optional) The identity provider user configuration. See below for more information.
    metadata Map<String>
    • The user kind metadata.
    ownerReference Map<String>
    • (Optional) The reference to a user.
    projectReferenceLists List<Property Map>
    • A list of projects the user is part of. See #reference for more details.
    state String
    • The state of the entity.
    userType String
    • The name of the user.
    projectReference Map<String>
    • (Optional) The reference to a project.
    userId String
    userName String

    Supporting Types

    GetUserAccessControlPolicyReferenceList

    Kind string
    • The kind name. (Default depends on the resource you are referencing)
    Name string
    • (Optional) The name for the user
    Uuid string
    • (Optional) The UUID for the user.
    Kind string
    • The kind name. (Default depends on the resource you are referencing)
    Name string
    • (Optional) The name for the user
    Uuid string
    • (Optional) The UUID for the user.
    kind String
    • The kind name. (Default depends on the resource you are referencing)
    name String
    • (Optional) The name for the user
    uuid String
    • (Optional) The UUID for the user.
    kind string
    • The kind name. (Default depends on the resource you are referencing)
    name string
    • (Optional) The name for the user
    uuid string
    • (Optional) The UUID for the user.
    kind str
    • The kind name. (Default depends on the resource you are referencing)
    name str
    • (Optional) The name for the user
    uuid str
    • (Optional) The UUID for the user.
    kind String
    • The kind name. (Default depends on the resource you are referencing)
    name String
    • (Optional) The name for the user
    uuid String
    • (Optional) The UUID for the user.

    GetUserCategory

    Name string
    • (Optional) The name for the user
    Value string
    • value of the key.
    Name string
    • (Optional) The name for the user
    Value string
    • value of the key.
    name String
    • (Optional) The name for the user
    value String
    • value of the key.
    name string
    • (Optional) The name for the user
    value string
    • value of the key.
    name str
    • (Optional) The name for the user
    value str
    • value of the key.
    name String
    • (Optional) The name for the user
    value String
    • value of the key.

    GetUserDirectoryServiceUser

    DefaultUserPrincipalName string
    DirectoryServiceReferences List<PiersKarsenbarg.Nutanix.Inputs.GetUserDirectoryServiceUserDirectoryServiceReference>
    • (Optional) The reference to a directory service. See #reference for to look the supported attributes.
    UserPrincipalName string
    • (Optional) The UserPrincipalName of the user from the directory service.
    DefaultUserPrincipalName string
    DirectoryServiceReferences []GetUserDirectoryServiceUserDirectoryServiceReference
    • (Optional) The reference to a directory service. See #reference for to look the supported attributes.
    UserPrincipalName string
    • (Optional) The UserPrincipalName of the user from the directory service.
    defaultUserPrincipalName String
    directoryServiceReferences List<GetUserDirectoryServiceUserDirectoryServiceReference>
    • (Optional) The reference to a directory service. See #reference for to look the supported attributes.
    userPrincipalName String
    • (Optional) The UserPrincipalName of the user from the directory service.
    defaultUserPrincipalName string
    directoryServiceReferences GetUserDirectoryServiceUserDirectoryServiceReference[]
    • (Optional) The reference to a directory service. See #reference for to look the supported attributes.
    userPrincipalName string
    • (Optional) The UserPrincipalName of the user from the directory service.
    default_user_principal_name str
    directory_service_references Sequence[GetUserDirectoryServiceUserDirectoryServiceReference]
    • (Optional) The reference to a directory service. See #reference for to look the supported attributes.
    user_principal_name str
    • (Optional) The UserPrincipalName of the user from the directory service.
    defaultUserPrincipalName String
    directoryServiceReferences List<Property Map>
    • (Optional) The reference to a directory service. See #reference for to look the supported attributes.
    userPrincipalName String
    • (Optional) The UserPrincipalName of the user from the directory service.

    GetUserDirectoryServiceUserDirectoryServiceReference

    Kind string
    • The kind name. (Default depends on the resource you are referencing)
    Name string
    • (Optional) The name for the user
    Uuid string
    • (Optional) The UUID for the user.
    Kind string
    • The kind name. (Default depends on the resource you are referencing)
    Name string
    • (Optional) The name for the user
    Uuid string
    • (Optional) The UUID for the user.
    kind String
    • The kind name. (Default depends on the resource you are referencing)
    name String
    • (Optional) The name for the user
    uuid String
    • (Optional) The UUID for the user.
    kind string
    • The kind name. (Default depends on the resource you are referencing)
    name string
    • (Optional) The name for the user
    uuid string
    • (Optional) The UUID for the user.
    kind str
    • The kind name. (Default depends on the resource you are referencing)
    name str
    • (Optional) The name for the user
    uuid str
    • (Optional) The UUID for the user.
    kind String
    • The kind name. (Default depends on the resource you are referencing)
    name String
    • (Optional) The name for the user
    uuid String
    • (Optional) The UUID for the user.

    GetUserIdentityProviderUser

    IdentityProviderReferences List<PiersKarsenbarg.Nutanix.Inputs.GetUserIdentityProviderUserIdentityProviderReference>
    • (Optional) The reference to a identity provider. See #reference for to look the supported attributes.
    Username string
    • (Optional) The username from identity provider. Name ID for SAML Identity Provider.
    IdentityProviderReferences []GetUserIdentityProviderUserIdentityProviderReference
    • (Optional) The reference to a identity provider. See #reference for to look the supported attributes.
    Username string
    • (Optional) The username from identity provider. Name ID for SAML Identity Provider.
    identityProviderReferences List<GetUserIdentityProviderUserIdentityProviderReference>
    • (Optional) The reference to a identity provider. See #reference for to look the supported attributes.
    username String
    • (Optional) The username from identity provider. Name ID for SAML Identity Provider.
    identityProviderReferences GetUserIdentityProviderUserIdentityProviderReference[]
    • (Optional) The reference to a identity provider. See #reference for to look the supported attributes.
    username string
    • (Optional) The username from identity provider. Name ID for SAML Identity Provider.
    identity_provider_references Sequence[GetUserIdentityProviderUserIdentityProviderReference]
    • (Optional) The reference to a identity provider. See #reference for to look the supported attributes.
    username str
    • (Optional) The username from identity provider. Name ID for SAML Identity Provider.
    identityProviderReferences List<Property Map>
    • (Optional) The reference to a identity provider. See #reference for to look the supported attributes.
    username String
    • (Optional) The username from identity provider. Name ID for SAML Identity Provider.

    GetUserIdentityProviderUserIdentityProviderReference

    Kind string
    • The kind name. (Default depends on the resource you are referencing)
    Name string
    • (Optional) The name for the user
    Uuid string
    • (Optional) The UUID for the user.
    Kind string
    • The kind name. (Default depends on the resource you are referencing)
    Name string
    • (Optional) The name for the user
    Uuid string
    • (Optional) The UUID for the user.
    kind String
    • The kind name. (Default depends on the resource you are referencing)
    name String
    • (Optional) The name for the user
    uuid String
    • (Optional) The UUID for the user.
    kind string
    • The kind name. (Default depends on the resource you are referencing)
    name string
    • (Optional) The name for the user
    uuid string
    • (Optional) The UUID for the user.
    kind str
    • The kind name. (Default depends on the resource you are referencing)
    name str
    • (Optional) The name for the user
    uuid str
    • (Optional) The UUID for the user.
    kind String
    • The kind name. (Default depends on the resource you are referencing)
    name String
    • (Optional) The name for the user
    uuid String
    • (Optional) The UUID for the user.

    GetUserProjectReferenceList

    Kind string
    • The kind name. (Default depends on the resource you are referencing)
    Name string
    • (Optional) The name for the user
    Uuid string
    • (Optional) The UUID for the user.
    Kind string
    • The kind name. (Default depends on the resource you are referencing)
    Name string
    • (Optional) The name for the user
    Uuid string
    • (Optional) The UUID for the user.
    kind String
    • The kind name. (Default depends on the resource you are referencing)
    name String
    • (Optional) The name for the user
    uuid String
    • (Optional) The UUID for the user.
    kind string
    • The kind name. (Default depends on the resource you are referencing)
    name string
    • (Optional) The name for the user
    uuid string
    • (Optional) The UUID for the user.
    kind str
    • The kind name. (Default depends on the resource you are referencing)
    name str
    • (Optional) The name for the user
    uuid str
    • (Optional) The UUID for the user.
    kind String
    • The kind name. (Default depends on the resource you are referencing)
    name String
    • (Optional) The name for the user
    uuid String
    • (Optional) The UUID for the user.

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Viewing docs for Nutanix v0.11.0
    published on Monday, Nov 24, 2025 by Piers Karsenbarg
    Schema (JSON)
    pierskarsenbarg/pulumi-nutanix
      Try Pulumi Cloud free. Your team will thank you.