Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Nutanix
  4. API Docs
  5. getIamEntityV2
Viewing docs for Nutanix v0.16.0
published on Tuesday, May 26, 2026 by Piers Karsenbarg
Schema (JSON)
pierskarsenbarg/pulumi-nutanix

nutanix.getIamEntityV2

nutanix logo
Viewing docs for Nutanix v0.16.0
published on Tuesday, May 26, 2026 by Piers Karsenbarg
Schema (JSON)
pierskarsenbarg/pulumi-nutanix

    Provides a datasource to retrieve an IAM Entity by its external identifier. Entities are used in authorization policies (e.g. user, role, cluster).

    Example Usage

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

// Get entity by ext_id
const example = nutanix.getIamEntityV2({
    extId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
});
export const entityName = example.then(example => example.name);

    import pulumi
import pulumi_nutanix as nutanix

# Get entity by ext_id
example = nutanix.get_iam_entity_v2(ext_id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
pulumi.export("entityName", example.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 {
		// Get entity by ext_id
		example, err := nutanix.GetIamEntityV2(ctx, &nutanix.GetIamEntityV2Args{
			ExtId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("entityName", example.Name)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Get entity by ext_id
    var example = Nutanix.GetIamEntityV2.Invoke(new()
    {
        ExtId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    });

    return new Dictionary<string, object?>
    {
        ["entityName"] = example.Apply(getIamEntityV2Result => getIamEntityV2Result.Name),
    };
});

    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.GetIamEntityV2Args;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        // Get entity by ext_id
        final var example = NutanixFunctions.getIamEntityV2(GetIamEntityV2Args.builder()
            .extId("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
            .build());

        ctx.export("entityName", example.name());
    }
}

    variables:
  # Get entity by ext_id
  example:
    fn::invoke:
      function: nutanix:getIamEntityV2
      arguments:
        extId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
outputs:
  entityName: ${example.name}

    pulumi {
  required_providers {
    nutanix = {
      source = "pulumi/nutanix"
    }
  }
}

data "nutanix_getiamentityv2" "example" {
  ext_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

# Get entity by ext_id
output "entityName" {
  value = data.nutanix_getiamentityv2.example.name
}

    Using getIamEntityV2

    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 getIamEntityV2(args: GetIamEntityV2Args, opts?: InvokeOptions): Promise<GetIamEntityV2Result>
function getIamEntityV2Output(args: GetIamEntityV2OutputArgs, opts?: InvokeOptions): Output<GetIamEntityV2Result>
    def get_iam_entity_v2(ext_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetIamEntityV2Result
def get_iam_entity_v2_output(ext_id: pulumi.Input[Optional[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetIamEntityV2Result]
    func GetIamEntityV2(ctx *Context, args *GetIamEntityV2Args, opts ...InvokeOption) (*GetIamEntityV2Result, error)
func GetIamEntityV2Output(ctx *Context, args *GetIamEntityV2OutputArgs, opts ...InvokeOption) GetIamEntityV2ResultOutput

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

    public static class GetIamEntityV2 
{
    public static Task<GetIamEntityV2Result> InvokeAsync(GetIamEntityV2Args args, InvokeOptions? opts = null)
    public static Output<GetIamEntityV2Result> Invoke(GetIamEntityV2InvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIamEntityV2Result> getIamEntityV2(GetIamEntityV2Args args, InvokeOptions options)
public static Output<GetIamEntityV2Result> getIamEntityV2(GetIamEntityV2Args args, InvokeOptions options)

    fn::invoke:
  function: nutanix:index/getIamEntityV2:getIamEntityV2
  arguments:
    # arguments dictionary
    data "nutanix_getiamentityv2" "name" {
    # arguments
}

    The following arguments are supported:

    ExtId string
    External identifier of the IAM Entity.
    ExtId string
    External identifier of the IAM Entity.
    ext_id string
    External identifier of the IAM Entity.
    extId String
    External identifier of the IAM Entity.
    extId string
    External identifier of the IAM Entity.
    ext_id str
    External identifier of the IAM Entity.
    extId String
    External identifier of the IAM Entity.

    getIamEntityV2 Result

    The following output properties are available:

    AttributeLists List<PiersKarsenbarg.Nutanix.Outputs.GetIamEntityV2AttributeList>
    List of attributes for the Entity (used in authorization policy filters).
    ClientName string
    Client that created the entity.
    CreatedBy string
    User or Service that created the Entity.
    CreatedTime string
    Creation time of the Entity.
    Description string
    Description of the Entity.
    DisplayName string
    Display name of the entity's attribute.
    ExtId string
    External identifier of the attribute.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsLogicalAndSupportedForAttributes bool
    Whether logical AND is supported for attributes. Indicates whether the entity supports scoping using multiple attributes which will result in a logical AND.
    LastUpdatedTime string
    Last updated time of the Entity.
    Links List<PiersKarsenbarg.Nutanix.Outputs.GetIamEntityV2Link>
    HATEOAS links for the attribute (each with href and rel).
    Name string
    Name of the entity's attribute used in Authorization Policy filters.
    SearchUrl string
    Search URL for the Entity. URL provided by the client to search the entities.
    TenantId string
    Tenant identifier for the attribute.
    AttributeLists []GetIamEntityV2AttributeList
    List of attributes for the Entity (used in authorization policy filters).
    ClientName string
    Client that created the entity.
    CreatedBy string
    User or Service that created the Entity.
    CreatedTime string
    Creation time of the Entity.
    Description string
    Description of the Entity.
    DisplayName string
    Display name of the entity's attribute.
    ExtId string
    External identifier of the attribute.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsLogicalAndSupportedForAttributes bool
    Whether logical AND is supported for attributes. Indicates whether the entity supports scoping using multiple attributes which will result in a logical AND.
    LastUpdatedTime string
    Last updated time of the Entity.
    Links []GetIamEntityV2Link
    HATEOAS links for the attribute (each with href and rel).
    Name string
    Name of the entity's attribute used in Authorization Policy filters.
    SearchUrl string
    Search URL for the Entity. URL provided by the client to search the entities.
    TenantId string
    Tenant identifier for the attribute.
    attribute_lists list(object)
    List of attributes for the Entity (used in authorization policy filters).
    client_name string
    Client that created the entity.
    created_by string
    User or Service that created the Entity.
    created_time string
    Creation time of the Entity.
    description string
    Description of the Entity.
    display_name string
    Display name of the entity's attribute.
    ext_id string
    External identifier of the attribute.
    id string
    The provider-assigned unique ID for this managed resource.
    is_logical_and_supported_for_attributes bool
    Whether logical AND is supported for attributes. Indicates whether the entity supports scoping using multiple attributes which will result in a logical AND.
    last_updated_time string
    Last updated time of the Entity.
    links list(object)
    HATEOAS links for the attribute (each with href and rel).
    name string
    Name of the entity's attribute used in Authorization Policy filters.
    search_url string
    Search URL for the Entity. URL provided by the client to search the entities.
    tenant_id string
    Tenant identifier for the attribute.
    attributeLists List<GetIamEntityV2AttributeList>
    List of attributes for the Entity (used in authorization policy filters).
    clientName String
    Client that created the entity.
    createdBy String
    User or Service that created the Entity.
    createdTime String
    Creation time of the Entity.
    description String
    Description of the Entity.
    displayName String
    Display name of the entity's attribute.
    extId String
    External identifier of the attribute.
    id String
    The provider-assigned unique ID for this managed resource.
    isLogicalAndSupportedForAttributes Boolean
    Whether logical AND is supported for attributes. Indicates whether the entity supports scoping using multiple attributes which will result in a logical AND.
    lastUpdatedTime String
    Last updated time of the Entity.
    links List<GetIamEntityV2Link>
    HATEOAS links for the attribute (each with href and rel).
    name String
    Name of the entity's attribute used in Authorization Policy filters.
    searchUrl String
    Search URL for the Entity. URL provided by the client to search the entities.
    tenantId String
    Tenant identifier for the attribute.
    attributeLists GetIamEntityV2AttributeList[]
    List of attributes for the Entity (used in authorization policy filters).
    clientName string
    Client that created the entity.
    createdBy string
    User or Service that created the Entity.
    createdTime string
    Creation time of the Entity.
    description string
    Description of the Entity.
    displayName string
    Display name of the entity's attribute.
    extId string
    External identifier of the attribute.
    id string
    The provider-assigned unique ID for this managed resource.
    isLogicalAndSupportedForAttributes boolean
    Whether logical AND is supported for attributes. Indicates whether the entity supports scoping using multiple attributes which will result in a logical AND.
    lastUpdatedTime string
    Last updated time of the Entity.
    links GetIamEntityV2Link[]
    HATEOAS links for the attribute (each with href and rel).
    name string
    Name of the entity's attribute used in Authorization Policy filters.
    searchUrl string
    Search URL for the Entity. URL provided by the client to search the entities.
    tenantId string
    Tenant identifier for the attribute.
    attribute_lists Sequence[GetIamEntityV2AttributeList]
    List of attributes for the Entity (used in authorization policy filters).
    client_name str
    Client that created the entity.
    created_by str
    User or Service that created the Entity.
    created_time str
    Creation time of the Entity.
    description str
    Description of the Entity.
    display_name str
    Display name of the entity's attribute.
    ext_id str
    External identifier of the attribute.
    id str
    The provider-assigned unique ID for this managed resource.
    is_logical_and_supported_for_attributes bool
    Whether logical AND is supported for attributes. Indicates whether the entity supports scoping using multiple attributes which will result in a logical AND.
    last_updated_time str
    Last updated time of the Entity.
    links Sequence[GetIamEntityV2Link]
    HATEOAS links for the attribute (each with href and rel).
    name str
    Name of the entity's attribute used in Authorization Policy filters.
    search_url str
    Search URL for the Entity. URL provided by the client to search the entities.
    tenant_id str
    Tenant identifier for the attribute.
    attributeLists List<Property Map>
    List of attributes for the Entity (used in authorization policy filters).
    clientName String
    Client that created the entity.
    createdBy String
    User or Service that created the Entity.
    createdTime String
    Creation time of the Entity.
    description String
    Description of the Entity.
    displayName String
    Display name of the entity's attribute.
    extId String
    External identifier of the attribute.
    id String
    The provider-assigned unique ID for this managed resource.
    isLogicalAndSupportedForAttributes Boolean
    Whether logical AND is supported for attributes. Indicates whether the entity supports scoping using multiple attributes which will result in a logical AND.
    lastUpdatedTime String
    Last updated time of the Entity.
    links List<Property Map>
    HATEOAS links for the attribute (each with href and rel).
    name String
    Name of the entity's attribute used in Authorization Policy filters.
    searchUrl String
    Search URL for the Entity. URL provided by the client to search the entities.
    tenantId String
    Tenant identifier for the attribute.

    Supporting Types

    GetIamEntityV2AttributeList

    AttributeValues List<string>
    List of attribute values supported for access control.
    DisplayName string
    Display name of the entity's attribute.
    ExtId string
    External identifier of the IAM Entity.
    Links List<PiersKarsenbarg.Nutanix.Inputs.GetIamEntityV2AttributeListLink>
    HATEOAS links for the attribute (each with href and rel).
    Name string
    Name of the entity's attribute used in Authorization Policy filters.
    SupportedOperators List<string>
    List of supported operators for this entity attribute.
    TenantId string
    Tenant identifier for the attribute.
    AttributeValues []string
    List of attribute values supported for access control.
    DisplayName string
    Display name of the entity's attribute.
    ExtId string
    External identifier of the IAM Entity.
    Links []GetIamEntityV2AttributeListLink
    HATEOAS links for the attribute (each with href and rel).
    Name string
    Name of the entity's attribute used in Authorization Policy filters.
    SupportedOperators []string
    List of supported operators for this entity attribute.
    TenantId string
    Tenant identifier for the attribute.
    attribute_values list(string)
    List of attribute values supported for access control.
    display_name string
    Display name of the entity's attribute.
    ext_id string
    External identifier of the IAM Entity.
    links list(object)
    HATEOAS links for the attribute (each with href and rel).
    name string
    Name of the entity's attribute used in Authorization Policy filters.
    supported_operators list(string)
    List of supported operators for this entity attribute.
    tenant_id string
    Tenant identifier for the attribute.
    attributeValues List<String>
    List of attribute values supported for access control.
    displayName String
    Display name of the entity's attribute.
    extId String
    External identifier of the IAM Entity.
    links List<GetIamEntityV2AttributeListLink>
    HATEOAS links for the attribute (each with href and rel).
    name String
    Name of the entity's attribute used in Authorization Policy filters.
    supportedOperators List<String>
    List of supported operators for this entity attribute.
    tenantId String
    Tenant identifier for the attribute.
    attributeValues string[]
    List of attribute values supported for access control.
    displayName string
    Display name of the entity's attribute.
    extId string
    External identifier of the IAM Entity.
    links GetIamEntityV2AttributeListLink[]
    HATEOAS links for the attribute (each with href and rel).
    name string
    Name of the entity's attribute used in Authorization Policy filters.
    supportedOperators string[]
    List of supported operators for this entity attribute.
    tenantId string
    Tenant identifier for the attribute.
    attribute_values Sequence[str]
    List of attribute values supported for access control.
    display_name str
    Display name of the entity's attribute.
    ext_id str
    External identifier of the IAM Entity.
    links Sequence[GetIamEntityV2AttributeListLink]
    HATEOAS links for the attribute (each with href and rel).
    name str
    Name of the entity's attribute used in Authorization Policy filters.
    supported_operators Sequence[str]
    List of supported operators for this entity attribute.
    tenant_id str
    Tenant identifier for the attribute.
    attributeValues List<String>
    List of attribute values supported for access control.
    displayName String
    Display name of the entity's attribute.
    extId String
    External identifier of the IAM Entity.
    links List<Property Map>
    HATEOAS links for the attribute (each with href and rel).
    name String
    Name of the entity's attribute used in Authorization Policy filters.
    supportedOperators List<String>
    List of supported operators for this entity attribute.
    tenantId String
    Tenant identifier for the attribute.
    Href string
    The URL at which the entity described by the link can be accessed.
    Rel string
    A name that identifies the relationship of the link to the object.
    Href string
    The URL at which the entity described by the link can be accessed.
    Rel string
    A name that identifies the relationship of the link to the object.
    href string
    The URL at which the entity described by the link can be accessed.
    rel string
    A name that identifies the relationship of the link to the object.
    href String
    The URL at which the entity described by the link can be accessed.
    rel String
    A name that identifies the relationship of the link to the object.
    href string
    The URL at which the entity described by the link can be accessed.
    rel string
    A name that identifies the relationship of the link to the object.
    href str
    The URL at which the entity described by the link can be accessed.
    rel str
    A name that identifies the relationship of the link to the object.
    href String
    The URL at which the entity described by the link can be accessed.
    rel String
    A name that identifies the relationship of the link to the object.
    Href string
    The URL at which the entity described by the link can be accessed.
    Rel string
    A name that identifies the relationship of the link to the object.
    Href string
    The URL at which the entity described by the link can be accessed.
    Rel string
    A name that identifies the relationship of the link to the object.
    href string
    The URL at which the entity described by the link can be accessed.
    rel string
    A name that identifies the relationship of the link to the object.
    href String
    The URL at which the entity described by the link can be accessed.
    rel String
    A name that identifies the relationship of the link to the object.
    href string
    The URL at which the entity described by the link can be accessed.
    rel string
    A name that identifies the relationship of the link to the object.
    href str
    The URL at which the entity described by the link can be accessed.
    rel str
    A name that identifies the relationship of the link to the object.
    href String
    The URL at which the entity described by the link can be accessed.
    rel String
    A name that identifies the relationship of the link to the object.

    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.16.0
    published on Tuesday, May 26, 2026 by Piers Karsenbarg
    Schema (JSON)
    pierskarsenbarg/pulumi-nutanix

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial