Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nutanix
  3. API Docs
  4. getUser
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

nutanix.getUser

Explore with Pulumi AI

Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

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

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(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]
Copy
func LookupUser(ctx *Context, args *LookupUserArgs, opts ...InvokeOption) (*LookupUserResult, error)
func LookupUserOutput(ctx *Context, args *LookupUserOutputArgs, opts ...InvokeOption) LookupUserResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
public static Output<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nutanix:index/getUser:getUser
  arguments:
    # arguments dictionary
Copy

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 This property is required. string
  • The kind name. (Default depends on the resource you are referencing)
Name This property is required. string
  • (Optional) The name for the user
Uuid This property is required. string
  • (Optional) The UUID for the user.
Kind This property is required. string
  • The kind name. (Default depends on the resource you are referencing)
Name This property is required. string
  • (Optional) The name for the user
Uuid This property is required. string
  • (Optional) The UUID for the user.
kind This property is required. String
  • The kind name. (Default depends on the resource you are referencing)
name This property is required. String
  • (Optional) The name for the user
uuid This property is required. String
  • (Optional) The UUID for the user.
kind This property is required. string
  • The kind name. (Default depends on the resource you are referencing)
name This property is required. string
  • (Optional) The name for the user
uuid This property is required. string
  • (Optional) The UUID for the user.
kind This property is required. str
  • The kind name. (Default depends on the resource you are referencing)
name This property is required. str
  • (Optional) The name for the user
uuid This property is required. str
  • (Optional) The UUID for the user.
kind This property is required. String
  • The kind name. (Default depends on the resource you are referencing)
name This property is required. String
  • (Optional) The name for the user
uuid This property is required. String
  • (Optional) The UUID for the user.

GetUserCategory

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

GetUserDirectoryServiceUser

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

GetUserDirectoryServiceUserDirectoryServiceReference

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

GetUserIdentityProviderUser

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

GetUserIdentityProviderUserIdentityProviderReference

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

GetUserProjectReferenceList

Kind This property is required. string
  • The kind name. (Default depends on the resource you are referencing)
Name This property is required. string
  • (Optional) The name for the user
Uuid This property is required. string
  • (Optional) The UUID for the user.
Kind This property is required. string
  • The kind name. (Default depends on the resource you are referencing)
Name This property is required. string
  • (Optional) The name for the user
Uuid This property is required. string
  • (Optional) The UUID for the user.
kind This property is required. String
  • The kind name. (Default depends on the resource you are referencing)
name This property is required. String
  • (Optional) The name for the user
uuid This property is required. String
  • (Optional) The UUID for the user.
kind This property is required. string
  • The kind name. (Default depends on the resource you are referencing)
name This property is required. string
  • (Optional) The name for the user
uuid This property is required. string
  • (Optional) The UUID for the user.
kind This property is required. str
  • The kind name. (Default depends on the resource you are referencing)
name This property is required. str
  • (Optional) The name for the user
uuid This property is required. str
  • (Optional) The UUID for the user.
kind This property is required. String
  • The kind name. (Default depends on the resource you are referencing)
name This property is required. String
  • (Optional) The name for the user
uuid This property is required. 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 v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix