Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
nutanix.getUsersV2
Explore with Pulumi AI
Provides a datasource to retrieve all User(s).
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as nutanix from "@pulumi/nutanix";
const users = nutanix.getUsersV2({});
import pulumi
import pulumi_nutanix as nutanix
users = nutanix.get_users_v2()
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 {
		_, err := nutanix.LookupUsersV2(ctx, &nutanix.LookupUsersV2Args{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nutanix = Pulumi.Nutanix;
return await Deployment.RunAsync(() => 
{
    var users = Nutanix.GetUsersV2.Invoke();
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.NutanixFunctions;
import com.pulumi.nutanix.inputs.GetUsersV2Args;
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 users = NutanixFunctions.getUsersV2();
    }
}
variables:
  users:
    fn::invoke:
      function: nutanix:getUsersV2
      arguments: {}
Argument Reference
The following arguments are supported:
- page: - A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
- limit: A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
- filter:A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. For example, filter ‘$filter=name eq ‘karbon-ntnx-1.0’ would filter the result on cluster name ‘karbon-ntnx1.0’, filter ‘$filter=startswith(name, ‘C’)’ would filter on cluster name starting with ‘C’. The filter can be applied to the following fields:- createdBy
- displayName
- emailId
- extId
- firstName
- idpId
- lastName
- lastUpdatedBy
- status
- userType
- username
 
- orderby: A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, ‘$orderby=templateName desc’ would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: * createdBy- createdTime
- displayName
- emailId
- extId
- firstName
- lastLoginTime
- lastName
- lastUpdatedTime
- userType
- username
 
- select: A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. following fields:- additionalAttributes
- bucketsAccessKeys
- createdBy
- createdTime
- displayName
- emailId
- extId
- firstName
- idpId
- isForceResetPasswordEnabled
- lastLoginTime
- lastName
- lastUpdatedBy
- lastUpdatedTime
- links
- locale
- middleInitial
- region
- status
- tenantId
- userType
- username
 
Using getUsersV2
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 getUsersV2(args: GetUsersV2Args, opts?: InvokeOptions): Promise<GetUsersV2Result>
function getUsersV2Output(args: GetUsersV2OutputArgs, opts?: InvokeOptions): Output<GetUsersV2Result>def get_users_v2(filter: Optional[str] = None,
                 limit: Optional[int] = None,
                 order_by: Optional[str] = None,
                 page: Optional[int] = None,
                 select: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetUsersV2Result
def get_users_v2_output(filter: Optional[pulumi.Input[str]] = None,
                 limit: Optional[pulumi.Input[int]] = None,
                 order_by: Optional[pulumi.Input[str]] = None,
                 page: Optional[pulumi.Input[int]] = None,
                 select: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetUsersV2Result]func LookupUsersV2(ctx *Context, args *LookupUsersV2Args, opts ...InvokeOption) (*LookupUsersV2Result, error)
func LookupUsersV2Output(ctx *Context, args *LookupUsersV2OutputArgs, opts ...InvokeOption) LookupUsersV2ResultOutput> Note: This function is named LookupUsersV2 in the Go SDK.
public static class GetUsersV2 
{
    public static Task<GetUsersV2Result> InvokeAsync(GetUsersV2Args args, InvokeOptions? opts = null)
    public static Output<GetUsersV2Result> Invoke(GetUsersV2InvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetUsersV2Result> getUsersV2(GetUsersV2Args args, InvokeOptions options)
public static Output<GetUsersV2Result> getUsersV2(GetUsersV2Args args, InvokeOptions options)
fn::invoke:
  function: nutanix:index/getUsersV2:getUsersV2
  arguments:
    # arguments dictionaryThe following arguments are supported:
getUsersV2 Result
The following output properties are available:
Supporting Types
GetUsersV2User  
- AdditionalAttributes List<PiersKarsenbarg. Nutanix. Inputs. Get Users V2User Additional Attribute> 
- Any additional attribute for the User.
 
- BucketsAccess List<PiersKeys Karsenbarg. Nutanix. Inputs. Get Users V2User Buckets Access Key> 
- Bucket Access Keys for the User.
 
- CreatedBy string
- User or Service who created the User.
 
- CreatedTime string
- Creation time for the Bucket Access Key.
 
- DisplayName string
- Display name for the User.
 
- EmailId string
- Email Id for the User.
 
- ExtId string
- A globally unique identifier of an instance that is suitable for external consumption.
 
- FirstName string
- First name for the User.
 
- IdpId string
- Identifier of the IDP for the User.
 
- IsForce boolReset Password 
- Flag to force the User to reset password.
 
- LastLogin stringTime 
- Last successful logged in time for the User.
 
- LastName string
- Last name for the User.
 
- LastUpdated stringBy 
- Last updated by this User ID.
 
- LastUpdated stringTime 
- Last updated time of the User.
 
- Links
List<PiersKarsenbarg. Nutanix. Inputs. Get Users V2User Link> 
- A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
 
- Locale string
- Default locale for the User.
 
- MiddleInitial string
- Middle name for the User.
 
- Region string
- Default Region for the User.
 
- Status string
- Status of the User. ACTIVE: Denotes that the local User is active.INACTIVE: Denotes that the local User is inactive and needs to be reactivated.
 
- Status of the User. 
- TenantId string
- A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
 
- UserType string
- Enum: $UNKNOWN$REDACTEDLOCALSAMLLDAPEXTERNALType of the User.
 
- Enum: 
- Username string
- Identifier for the User in the form an email address.
 
- AdditionalAttributes []GetUsers V2User Additional Attribute 
- Any additional attribute for the User.
 
- BucketsAccess []GetKeys Users V2User Buckets Access Key 
- Bucket Access Keys for the User.
 
- CreatedBy string
- User or Service who created the User.
 
- CreatedTime string
- Creation time for the Bucket Access Key.
 
- DisplayName string
- Display name for the User.
 
- EmailId string
- Email Id for the User.
 
- ExtId string
- A globally unique identifier of an instance that is suitable for external consumption.
 
- FirstName string
- First name for the User.
 
- IdpId string
- Identifier of the IDP for the User.
 
- IsForce boolReset Password 
- Flag to force the User to reset password.
 
- LastLogin stringTime 
- Last successful logged in time for the User.
 
- LastName string
- Last name for the User.
 
- LastUpdated stringBy 
- Last updated by this User ID.
 
- LastUpdated stringTime 
- Last updated time of the User.
 
- Links
[]GetUsers V2User Link 
- A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
 
- Locale string
- Default locale for the User.
 
- MiddleInitial string
- Middle name for the User.
 
- Region string
- Default Region for the User.
 
- Status string
- Status of the User. ACTIVE: Denotes that the local User is active.INACTIVE: Denotes that the local User is inactive and needs to be reactivated.
 
- Status of the User. 
- TenantId string
- A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
 
- UserType string
- Enum: $UNKNOWN$REDACTEDLOCALSAMLLDAPEXTERNALType of the User.
 
- Enum: 
- Username string
- Identifier for the User in the form an email address.
 
- additionalAttributes List<GetUsers V2User Additional Attribute> 
- Any additional attribute for the User.
 
- bucketsAccess List<GetKeys Users V2User Buckets Access Key> 
- Bucket Access Keys for the User.
 
- createdBy String
- User or Service who created the User.
 
- createdTime String
- Creation time for the Bucket Access Key.
 
- displayName String
- Display name for the User.
 
- emailId String
- Email Id for the User.
 
- extId String
- A globally unique identifier of an instance that is suitable for external consumption.
 
- firstName String
- First name for the User.
 
- idpId String
- Identifier of the IDP for the User.
 
- isForce BooleanReset Password 
- Flag to force the User to reset password.
 
- lastLogin StringTime 
- Last successful logged in time for the User.
 
- lastName String
- Last name for the User.
 
- lastUpdated StringBy 
- Last updated by this User ID.
 
- lastUpdated StringTime 
- Last updated time of the User.
 
- links
List<GetUsers V2User Link> 
- A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
 
- locale String
- Default locale for the User.
 
- middleInitial String
- Middle name for the User.
 
- region String
- Default Region for the User.
 
- status String
- Status of the User. ACTIVE: Denotes that the local User is active.INACTIVE: Denotes that the local User is inactive and needs to be reactivated.
 
- Status of the User. 
- tenantId String
- A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
 
- userType String
- Enum: $UNKNOWN$REDACTEDLOCALSAMLLDAPEXTERNALType of the User.
 
- Enum: 
- username String
- Identifier for the User in the form an email address.
 
- additionalAttributes GetUsers V2User Additional Attribute[] 
- Any additional attribute for the User.
 
- bucketsAccess GetKeys Users V2User Buckets Access Key[] 
- Bucket Access Keys for the User.
 
- createdBy string
- User or Service who created the User.
 
- createdTime string
- Creation time for the Bucket Access Key.
 
- displayName string
- Display name for the User.
 
- emailId string
- Email Id for the User.
 
- extId string
- A globally unique identifier of an instance that is suitable for external consumption.
 
- firstName string
- First name for the User.
 
- idpId string
- Identifier of the IDP for the User.
 
- isForce booleanReset Password 
- Flag to force the User to reset password.
 
- lastLogin stringTime 
- Last successful logged in time for the User.
 
- lastName string
- Last name for the User.
 
- lastUpdated stringBy 
- Last updated by this User ID.
 
- lastUpdated stringTime 
- Last updated time of the User.
 
- links
GetUsers V2User Link[] 
- A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
 
- locale string
- Default locale for the User.
 
- middleInitial string
- Middle name for the User.
 
- region string
- Default Region for the User.
 
- status string
- Status of the User. ACTIVE: Denotes that the local User is active.INACTIVE: Denotes that the local User is inactive and needs to be reactivated.
 
- Status of the User. 
- tenantId string
- A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
 
- userType string
- Enum: $UNKNOWN$REDACTEDLOCALSAMLLDAPEXTERNALType of the User.
 
- Enum: 
- username string
- Identifier for the User in the form an email address.
 
- additional_attributes Sequence[GetUsers V2User Additional Attribute] 
- Any additional attribute for the User.
 
- buckets_access_ Sequence[Getkeys Users V2User Buckets Access Key] 
- Bucket Access Keys for the User.
 
- created_by str
- User or Service who created the User.
 
- created_time str
- Creation time for the Bucket Access Key.
 
- display_name str
- Display name for the User.
 
- email_id str
- Email Id for the User.
 
- ext_id str
- A globally unique identifier of an instance that is suitable for external consumption.
 
- first_name str
- First name for the User.
 
- idp_id str
- Identifier of the IDP for the User.
 
- is_force_ boolreset_ password 
- Flag to force the User to reset password.
 
- last_login_ strtime 
- Last successful logged in time for the User.
 
- last_name str
- Last name for the User.
 
- last_updated_ strby 
- Last updated by this User ID.
 
- last_updated_ strtime 
- Last updated time of the User.
 
- links
Sequence[GetUsers V2User Link] 
- A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
 
- locale str
- Default locale for the User.
 
- middle_initial str
- Middle name for the User.
 
- region str
- Default Region for the User.
 
- status str
- Status of the User. ACTIVE: Denotes that the local User is active.INACTIVE: Denotes that the local User is inactive and needs to be reactivated.
 
- Status of the User. 
- tenant_id str
- A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
 
- user_type str
- Enum: $UNKNOWN$REDACTEDLOCALSAMLLDAPEXTERNALType of the User.
 
- Enum: 
- username str
- Identifier for the User in the form an email address.
 
- additionalAttributes List<Property Map>
- Any additional attribute for the User.
 
- bucketsAccess List<Property Map>Keys 
- Bucket Access Keys for the User.
 
- createdBy String
- User or Service who created the User.
 
- createdTime String
- Creation time for the Bucket Access Key.
 
- displayName String
- Display name for the User.
 
- emailId String
- Email Id for the User.
 
- extId String
- A globally unique identifier of an instance that is suitable for external consumption.
 
- firstName String
- First name for the User.
 
- idpId String
- Identifier of the IDP for the User.
 
- isForce BooleanReset Password 
- Flag to force the User to reset password.
 
- lastLogin StringTime 
- Last successful logged in time for the User.
 
- lastName String
- Last name for the User.
 
- lastUpdated StringBy 
- Last updated by this User ID.
 
- lastUpdated StringTime 
- Last updated time of the User.
 
- links List<Property Map>
- A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
 
- locale String
- Default locale for the User.
 
- middleInitial String
- Middle name for the User.
 
- region String
- Default Region for the User.
 
- status String
- Status of the User. ACTIVE: Denotes that the local User is active.INACTIVE: Denotes that the local User is inactive and needs to be reactivated.
 
- Status of the User. 
- tenantId String
- A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this Id to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server).
 
- userType String
- Enum: $UNKNOWN$REDACTEDLOCALSAMLLDAPEXTERNALType of the User.
 
- Enum: 
- username String
- Identifier for the User in the form an email address.
 
GetUsersV2UserAdditionalAttribute    
GetUsersV2UserBucketsAccessKey     
- AccessKey stringName 
- Name of the Bucket Access Key.
 
- CreatedTime string
- Creation time for the Bucket Access Key.
 
- ExtId string
- A globally unique identifier of an instance that is suitable for external consumption.
 
- Links
List<PiersKarsenbarg. Nutanix. Inputs. Get Users V2User Buckets Access Key Link> 
- A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
 
- SecretAccess stringKey 
- Secret Access Key, it will be returned only during Bucket Access Key creation.
 
- UserId string
- User Identifier who owns the Bucket Access Key.
 
- AccessKey stringName 
- Name of the Bucket Access Key.
 
- CreatedTime string
- Creation time for the Bucket Access Key.
 
- ExtId string
- A globally unique identifier of an instance that is suitable for external consumption.
 
- Links
[]GetUsers V2User Buckets Access Key Link 
- A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
 
- SecretAccess stringKey 
- Secret Access Key, it will be returned only during Bucket Access Key creation.
 
- UserId string
- User Identifier who owns the Bucket Access Key.
 
- accessKey StringName 
- Name of the Bucket Access Key.
 
- createdTime String
- Creation time for the Bucket Access Key.
 
- extId String
- A globally unique identifier of an instance that is suitable for external consumption.
 
- links
List<GetUsers V2User Buckets Access Key Link> 
- A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
 
- secretAccess StringKey 
- Secret Access Key, it will be returned only during Bucket Access Key creation.
 
- userId String
- User Identifier who owns the Bucket Access Key.
 
- accessKey stringName 
- Name of the Bucket Access Key.
 
- createdTime string
- Creation time for the Bucket Access Key.
 
- extId string
- A globally unique identifier of an instance that is suitable for external consumption.
 
- links
GetUsers V2User Buckets Access Key Link[] 
- A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
 
- secretAccess stringKey 
- Secret Access Key, it will be returned only during Bucket Access Key creation.
 
- userId string
- User Identifier who owns the Bucket Access Key.
 
- access_key_ strname 
- Name of the Bucket Access Key.
 
- created_time str
- Creation time for the Bucket Access Key.
 
- ext_id str
- A globally unique identifier of an instance that is suitable for external consumption.
 
- links
Sequence[GetUsers V2User Buckets Access Key Link] 
- A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
 
- secret_access_ strkey 
- Secret Access Key, it will be returned only during Bucket Access Key creation.
 
- user_id str
- User Identifier who owns the Bucket Access Key.
 
- accessKey StringName 
- Name of the Bucket Access Key.
 
- createdTime String
- Creation time for the Bucket Access Key.
 
- extId String
- A globally unique identifier of an instance that is suitable for external consumption.
 
- links List<Property Map>
- A HATEOAS style link for the response. Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource.
 
- secretAccess StringKey 
- Secret Access Key, it will be returned only during Bucket Access Key creation.
 
- userId String
- User Identifier who owns the Bucket Access Key.
 
GetUsersV2UserBucketsAccessKeyLink      
GetUsersV2UserLink   
Package Details
- Repository
- nutanix pierskarsenbarg/pulumi-nutanix
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the nutanixTerraform Provider.
