Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PrincipalIdentity
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.PrincipalIdentity

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

    Create PrincipalIdentity Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PrincipalIdentity(name: string, args: PrincipalIdentityArgs, opts?: CustomResourceOptions);
    @overload
def PrincipalIdentity(resource_name: str,
                      args: PrincipalIdentityArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def PrincipalIdentity(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      certificate_pem: Optional[str] = None,
                      node_id: Optional[str] = None,
                      roles_for_paths: Optional[Sequence[PrincipalIdentityRolesForPathArgs]] = None,
                      is_protected: Optional[bool] = None,
                      name: Optional[str] = None,
                      principal_identity_id: Optional[str] = None,
                      tags: Optional[Sequence[PrincipalIdentityTagArgs]] = None)
    func NewPrincipalIdentity(ctx *Context, name string, args PrincipalIdentityArgs, opts ...ResourceOption) (*PrincipalIdentity, error)
    public PrincipalIdentity(string name, PrincipalIdentityArgs args, CustomResourceOptions? opts = null)
    public PrincipalIdentity(String name, PrincipalIdentityArgs args)
public PrincipalIdentity(String name, PrincipalIdentityArgs args, CustomResourceOptions options)

    type: nsxt:PrincipalIdentity
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PrincipalIdentityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PrincipalIdentityArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PrincipalIdentityArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrincipalIdentityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrincipalIdentityArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var principalIdentityResource = new Nsxt.PrincipalIdentity("principalIdentityResource", new()
{
    CertificatePem = "string",
    NodeId = "string",
    RolesForPaths = new[]
    {
        new Nsxt.Inputs.PrincipalIdentityRolesForPathArgs
        {
            Path = "string",
            Roles = new[]
            {
                "string",
            },
        },
    },
    IsProtected = false,
    Name = "string",
    PrincipalIdentityId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PrincipalIdentityTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPrincipalIdentity(ctx, "principalIdentityResource", &nsxt.PrincipalIdentityArgs{
	CertificatePem: pulumi.String("string"),
	NodeId:         pulumi.String("string"),
	RolesForPaths: nsxt.PrincipalIdentityRolesForPathArray{
		&nsxt.PrincipalIdentityRolesForPathArgs{
			Path: pulumi.String("string"),
			Roles: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	IsProtected:         pulumi.Bool(false),
	Name:                pulumi.String("string"),
	PrincipalIdentityId: pulumi.String("string"),
	Tags: nsxt.PrincipalIdentityTagArray{
		&nsxt.PrincipalIdentityTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var principalIdentityResource = new PrincipalIdentity("principalIdentityResource", PrincipalIdentityArgs.builder()
    .certificatePem("string")
    .nodeId("string")
    .rolesForPaths(PrincipalIdentityRolesForPathArgs.builder()
        .path("string")
        .roles("string")
        .build())
    .isProtected(false)
    .name("string")
    .principalIdentityId("string")
    .tags(PrincipalIdentityTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    principal_identity_resource = nsxt.PrincipalIdentity("principalIdentityResource",
    certificate_pem="string",
    node_id="string",
    roles_for_paths=[{
        "path": "string",
        "roles": ["string"],
    }],
    is_protected=False,
    name="string",
    principal_identity_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const principalIdentityResource = new nsxt.PrincipalIdentity("principalIdentityResource", {
    certificatePem: "string",
    nodeId: "string",
    rolesForPaths: [{
        path: "string",
        roles: ["string"],
    }],
    isProtected: false,
    name: "string",
    principalIdentityId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PrincipalIdentity
properties:
    certificatePem: string
    isProtected: false
    name: string
    nodeId: string
    principalIdentityId: string
    rolesForPaths:
        - path: string
          roles:
            - string
    tags:
        - scope: string
          tag: string

    PrincipalIdentity Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PrincipalIdentity resource accepts the following input properties:

    CertificatePem string
    PEM encoding of the certificate to be associated with this principal identity.
    NodeId string
    Unique node-id of a principal. This is used primarily in the case where a cluster of nodes is used to make calls to the NSX Manager and the same name is used so that the nodes can access and modify the same data while still accessing NSX through their individual secret (certificate or JWT). In all other cases this can be any string.
    RolesForPaths List<PrincipalIdentityRolesForPath>
    A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
    IsProtected bool
    Indicates whether the entities created by this principal should be protected.
    Name string
    Name of the principal.
    PrincipalIdentityId string
    Tags List<PrincipalIdentityTag>
    A list of scope + tag pairs to associate with this resource.
    CertificatePem string
    PEM encoding of the certificate to be associated with this principal identity.
    NodeId string
    Unique node-id of a principal. This is used primarily in the case where a cluster of nodes is used to make calls to the NSX Manager and the same name is used so that the nodes can access and modify the same data while still accessing NSX through their individual secret (certificate or JWT). In all other cases this can be any string.
    RolesForPaths []PrincipalIdentityRolesForPathArgs
    A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
    IsProtected bool
    Indicates whether the entities created by this principal should be protected.
    Name string
    Name of the principal.
    PrincipalIdentityId string
    Tags []PrincipalIdentityTagArgs
    A list of scope + tag pairs to associate with this resource.
    certificatePem String
    PEM encoding of the certificate to be associated with this principal identity.
    nodeId String
    Unique node-id of a principal. This is used primarily in the case where a cluster of nodes is used to make calls to the NSX Manager and the same name is used so that the nodes can access and modify the same data while still accessing NSX through their individual secret (certificate or JWT). In all other cases this can be any string.
    rolesForPaths List<PrincipalIdentityRolesForPath>
    A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
    isProtected Boolean
    Indicates whether the entities created by this principal should be protected.
    name String
    Name of the principal.
    principalIdentityId String
    tags List<PrincipalIdentityTag>
    A list of scope + tag pairs to associate with this resource.
    certificatePem string
    PEM encoding of the certificate to be associated with this principal identity.
    nodeId string
    Unique node-id of a principal. This is used primarily in the case where a cluster of nodes is used to make calls to the NSX Manager and the same name is used so that the nodes can access and modify the same data while still accessing NSX through their individual secret (certificate or JWT). In all other cases this can be any string.
    rolesForPaths PrincipalIdentityRolesForPath[]
    A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
    isProtected boolean
    Indicates whether the entities created by this principal should be protected.
    name string
    Name of the principal.
    principalIdentityId string
    tags PrincipalIdentityTag[]
    A list of scope + tag pairs to associate with this resource.
    certificate_pem str
    PEM encoding of the certificate to be associated with this principal identity.
    node_id str
    Unique node-id of a principal. This is used primarily in the case where a cluster of nodes is used to make calls to the NSX Manager and the same name is used so that the nodes can access and modify the same data while still accessing NSX through their individual secret (certificate or JWT). In all other cases this can be any string.
    roles_for_paths Sequence[PrincipalIdentityRolesForPathArgs]
    A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
    is_protected bool
    Indicates whether the entities created by this principal should be protected.
    name str
    Name of the principal.
    principal_identity_id str
    tags Sequence[PrincipalIdentityTagArgs]
    A list of scope + tag pairs to associate with this resource.
    certificatePem String
    PEM encoding of the certificate to be associated with this principal identity.
    nodeId String
    Unique node-id of a principal. This is used primarily in the case where a cluster of nodes is used to make calls to the NSX Manager and the same name is used so that the nodes can access and modify the same data while still accessing NSX through their individual secret (certificate or JWT). In all other cases this can be any string.
    rolesForPaths List<Property Map>
    A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
    isProtected Boolean
    Indicates whether the entities created by this principal should be protected.
    name String
    Name of the principal.
    principalIdentityId String
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PrincipalIdentity resource produces the following output properties:

    CertificateId string
    NSX certificate ID of the imported certificate_pem.
    Id string
    The provider-assigned unique ID for this managed resource.
    CertificateId string
    NSX certificate ID of the imported certificate_pem.
    Id string
    The provider-assigned unique ID for this managed resource.
    certificateId String
    NSX certificate ID of the imported certificate_pem.
    id String
    The provider-assigned unique ID for this managed resource.
    certificateId string
    NSX certificate ID of the imported certificate_pem.
    id string
    The provider-assigned unique ID for this managed resource.
    certificate_id str
    NSX certificate ID of the imported certificate_pem.
    id str
    The provider-assigned unique ID for this managed resource.
    certificateId String
    NSX certificate ID of the imported certificate_pem.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing PrincipalIdentity Resource

    Get an existing PrincipalIdentity resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PrincipalIdentityState, opts?: CustomResourceOptions): PrincipalIdentity
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        certificate_id: Optional[str] = None,
        certificate_pem: Optional[str] = None,
        is_protected: Optional[bool] = None,
        name: Optional[str] = None,
        node_id: Optional[str] = None,
        principal_identity_id: Optional[str] = None,
        roles_for_paths: Optional[Sequence[PrincipalIdentityRolesForPathArgs]] = None,
        tags: Optional[Sequence[PrincipalIdentityTagArgs]] = None) -> PrincipalIdentity
    func GetPrincipalIdentity(ctx *Context, name string, id IDInput, state *PrincipalIdentityState, opts ...ResourceOption) (*PrincipalIdentity, error)
    public static PrincipalIdentity Get(string name, Input<string> id, PrincipalIdentityState? state, CustomResourceOptions? opts = null)
    public static PrincipalIdentity get(String name, Output<String> id, PrincipalIdentityState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PrincipalIdentity    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CertificateId string
    NSX certificate ID of the imported certificate_pem.
    CertificatePem string
    PEM encoding of the certificate to be associated with this principal identity.
    IsProtected bool
    Indicates whether the entities created by this principal should be protected.
    Name string
    Name of the principal.
    NodeId string
    Unique node-id of a principal. This is used primarily in the case where a cluster of nodes is used to make calls to the NSX Manager and the same name is used so that the nodes can access and modify the same data while still accessing NSX through their individual secret (certificate or JWT). In all other cases this can be any string.
    PrincipalIdentityId string
    RolesForPaths List<PrincipalIdentityRolesForPath>
    A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
    Tags List<PrincipalIdentityTag>
    A list of scope + tag pairs to associate with this resource.
    CertificateId string
    NSX certificate ID of the imported certificate_pem.
    CertificatePem string
    PEM encoding of the certificate to be associated with this principal identity.
    IsProtected bool
    Indicates whether the entities created by this principal should be protected.
    Name string
    Name of the principal.
    NodeId string
    Unique node-id of a principal. This is used primarily in the case where a cluster of nodes is used to make calls to the NSX Manager and the same name is used so that the nodes can access and modify the same data while still accessing NSX through their individual secret (certificate or JWT). In all other cases this can be any string.
    PrincipalIdentityId string
    RolesForPaths []PrincipalIdentityRolesForPathArgs
    A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
    Tags []PrincipalIdentityTagArgs
    A list of scope + tag pairs to associate with this resource.
    certificateId String
    NSX certificate ID of the imported certificate_pem.
    certificatePem String
    PEM encoding of the certificate to be associated with this principal identity.
    isProtected Boolean
    Indicates whether the entities created by this principal should be protected.
    name String
    Name of the principal.
    nodeId String
    Unique node-id of a principal. This is used primarily in the case where a cluster of nodes is used to make calls to the NSX Manager and the same name is used so that the nodes can access and modify the same data while still accessing NSX through their individual secret (certificate or JWT). In all other cases this can be any string.
    principalIdentityId String
    rolesForPaths List<PrincipalIdentityRolesForPath>
    A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
    tags List<PrincipalIdentityTag>
    A list of scope + tag pairs to associate with this resource.
    certificateId string
    NSX certificate ID of the imported certificate_pem.
    certificatePem string
    PEM encoding of the certificate to be associated with this principal identity.
    isProtected boolean
    Indicates whether the entities created by this principal should be protected.
    name string
    Name of the principal.
    nodeId string
    Unique node-id of a principal. This is used primarily in the case where a cluster of nodes is used to make calls to the NSX Manager and the same name is used so that the nodes can access and modify the same data while still accessing NSX through their individual secret (certificate or JWT). In all other cases this can be any string.
    principalIdentityId string
    rolesForPaths PrincipalIdentityRolesForPath[]
    A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
    tags PrincipalIdentityTag[]
    A list of scope + tag pairs to associate with this resource.
    certificate_id str
    NSX certificate ID of the imported certificate_pem.
    certificate_pem str
    PEM encoding of the certificate to be associated with this principal identity.
    is_protected bool
    Indicates whether the entities created by this principal should be protected.
    name str
    Name of the principal.
    node_id str
    Unique node-id of a principal. This is used primarily in the case where a cluster of nodes is used to make calls to the NSX Manager and the same name is used so that the nodes can access and modify the same data while still accessing NSX through their individual secret (certificate or JWT). In all other cases this can be any string.
    principal_identity_id str
    roles_for_paths Sequence[PrincipalIdentityRolesForPathArgs]
    A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
    tags Sequence[PrincipalIdentityTagArgs]
    A list of scope + tag pairs to associate with this resource.
    certificateId String
    NSX certificate ID of the imported certificate_pem.
    certificatePem String
    PEM encoding of the certificate to be associated with this principal identity.
    isProtected Boolean
    Indicates whether the entities created by this principal should be protected.
    name String
    Name of the principal.
    nodeId String
    Unique node-id of a principal. This is used primarily in the case where a cluster of nodes is used to make calls to the NSX Manager and the same name is used so that the nodes can access and modify the same data while still accessing NSX through their individual secret (certificate or JWT). In all other cases this can be any string.
    principalIdentityId String
    rolesForPaths List<Property Map>
    A list of The roles that are associated with the user, limiting them to a path. In case the path is '/', the roles apply everywhere.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Supporting Types

    PrincipalIdentityRolesForPath, PrincipalIdentityRolesForPathArgs

    Path string
    Path of the entity in parent hierarchy.
    Roles List<string>

    A list of identifiers for the roles to associate with the given user limited to a path.

    Once a Principal Identity is created, it can't be modified. Modification of above arguments will cause the current PI on NSX to be deleted and recreated. Certificate updates is also handled in the same way.

    Path string
    Path of the entity in parent hierarchy.
    Roles []string

    A list of identifiers for the roles to associate with the given user limited to a path.

    Once a Principal Identity is created, it can't be modified. Modification of above arguments will cause the current PI on NSX to be deleted and recreated. Certificate updates is also handled in the same way.

    path String
    Path of the entity in parent hierarchy.
    roles List<String>

    A list of identifiers for the roles to associate with the given user limited to a path.

    Once a Principal Identity is created, it can't be modified. Modification of above arguments will cause the current PI on NSX to be deleted and recreated. Certificate updates is also handled in the same way.

    path string
    Path of the entity in parent hierarchy.
    roles string[]

    A list of identifiers for the roles to associate with the given user limited to a path.

    Once a Principal Identity is created, it can't be modified. Modification of above arguments will cause the current PI on NSX to be deleted and recreated. Certificate updates is also handled in the same way.

    path str
    Path of the entity in parent hierarchy.
    roles Sequence[str]

    A list of identifiers for the roles to associate with the given user limited to a path.

    Once a Principal Identity is created, it can't be modified. Modification of above arguments will cause the current PI on NSX to be deleted and recreated. Certificate updates is also handled in the same way.

    path String
    Path of the entity in parent hierarchy.
    roles List<String>

    A list of identifiers for the roles to associate with the given user limited to a path.

    Once a Principal Identity is created, it can't be modified. Modification of above arguments will cause the current PI on NSX to be deleted and recreated. Certificate updates is also handled in the same way.

    PrincipalIdentityTag, PrincipalIdentityTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.
    scope string
    tag string
    A list of scope + tag pairs to associate with this resource.
    scope str
    tag str
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
    vmware/terraform-provider-nsxt