1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyUserManagementRoleBinding
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware

nsxt.PolicyUserManagementRoleBinding

Explore with Pulumi AI

Create PolicyUserManagementRoleBinding Resource

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

Constructor syntax

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

@overload
def PolicyUserManagementRoleBinding(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    roles_for_paths: Optional[Sequence[PolicyUserManagementRoleBindingRolesForPathArgs]] = None,
                                    type: Optional[str] = None,
                                    description: Optional[str] = None,
                                    display_name: Optional[str] = None,
                                    identity_source_id: Optional[str] = None,
                                    identity_source_type: Optional[str] = None,
                                    name: Optional[str] = None,
                                    overwrite_local_user: Optional[bool] = None,
                                    policy_user_management_role_binding_id: Optional[str] = None,
                                    tags: Optional[Sequence[PolicyUserManagementRoleBindingTagArgs]] = None)
func NewPolicyUserManagementRoleBinding(ctx *Context, name string, args PolicyUserManagementRoleBindingArgs, opts ...ResourceOption) (*PolicyUserManagementRoleBinding, error)
public PolicyUserManagementRoleBinding(string name, PolicyUserManagementRoleBindingArgs args, CustomResourceOptions? opts = null)
public PolicyUserManagementRoleBinding(String name, PolicyUserManagementRoleBindingArgs args)
public PolicyUserManagementRoleBinding(String name, PolicyUserManagementRoleBindingArgs args, CustomResourceOptions options)
type: nsxt:PolicyUserManagementRoleBinding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PolicyUserManagementRoleBindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PolicyUserManagementRoleBindingArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PolicyUserManagementRoleBindingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PolicyUserManagementRoleBindingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PolicyUserManagementRoleBindingArgs
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 policyUserManagementRoleBindingResource = new Nsxt.PolicyUserManagementRoleBinding("policyUserManagementRoleBindingResource", new()
{
    RolesForPaths = new[]
    {
        new Nsxt.Inputs.PolicyUserManagementRoleBindingRolesForPathArgs
        {
            Path = "string",
            Roles = new[]
            {
                "string",
            },
        },
    },
    Type = "string",
    Description = "string",
    DisplayName = "string",
    IdentitySourceId = "string",
    IdentitySourceType = "string",
    Name = "string",
    OverwriteLocalUser = false,
    PolicyUserManagementRoleBindingId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyUserManagementRoleBindingTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});
Copy
example, err := nsxt.NewPolicyUserManagementRoleBinding(ctx, "policyUserManagementRoleBindingResource", &nsxt.PolicyUserManagementRoleBindingArgs{
RolesForPaths: .PolicyUserManagementRoleBindingRolesForPathArray{
&.PolicyUserManagementRoleBindingRolesForPathArgs{
Path: pulumi.String("string"),
Roles: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Type: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
IdentitySourceId: pulumi.String("string"),
IdentitySourceType: pulumi.String("string"),
Name: pulumi.String("string"),
OverwriteLocalUser: pulumi.Bool(false),
PolicyUserManagementRoleBindingId: pulumi.String("string"),
Tags: .PolicyUserManagementRoleBindingTagArray{
&.PolicyUserManagementRoleBindingTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
})
Copy
var policyUserManagementRoleBindingResource = new PolicyUserManagementRoleBinding("policyUserManagementRoleBindingResource", PolicyUserManagementRoleBindingArgs.builder()
    .rolesForPaths(PolicyUserManagementRoleBindingRolesForPathArgs.builder()
        .path("string")
        .roles("string")
        .build())
    .type("string")
    .description("string")
    .displayName("string")
    .identitySourceId("string")
    .identitySourceType("string")
    .name("string")
    .overwriteLocalUser(false)
    .policyUserManagementRoleBindingId("string")
    .tags(PolicyUserManagementRoleBindingTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());
Copy
policy_user_management_role_binding_resource = nsxt.PolicyUserManagementRoleBinding("policyUserManagementRoleBindingResource",
    roles_for_paths=[{
        "path": "string",
        "roles": ["string"],
    }],
    type="string",
    description="string",
    display_name="string",
    identity_source_id="string",
    identity_source_type="string",
    name="string",
    overwrite_local_user=False,
    policy_user_management_role_binding_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])
Copy
const policyUserManagementRoleBindingResource = new nsxt.PolicyUserManagementRoleBinding("policyUserManagementRoleBindingResource", {
    rolesForPaths: [{
        path: "string",
        roles: ["string"],
    }],
    type: "string",
    description: "string",
    displayName: "string",
    identitySourceId: "string",
    identitySourceType: "string",
    name: "string",
    overwriteLocalUser: false,
    policyUserManagementRoleBindingId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});
Copy
type: nsxt:PolicyUserManagementRoleBinding
properties:
    description: string
    displayName: string
    identitySourceId: string
    identitySourceType: string
    name: string
    overwriteLocalUser: false
    policyUserManagementRoleBindingId: string
    rolesForPaths:
        - path: string
          roles:
            - string
    tags:
        - scope: string
          tag: string
    type: string
Copy

PolicyUserManagementRoleBinding 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 PolicyUserManagementRoleBinding resource accepts the following input properties:

RolesForPaths This property is required. List<PolicyUserManagementRoleBindingRolesForPath>
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.
Type This property is required. string
Indicates the type of the user. Valid options:
Description string
Description of the resource.
DisplayName string
Display name of the resource.
IdentitySourceId string
The ID of the external identity source that holds the referenced external entity. Currently, only external LDAP and OIDC servers are allowed.
IdentitySourceType string
Identity source type. Applicable only to remote_user and remote_group user types. Valid options are: VIDM, LDAP, OIDC, CSP. Defaults to VIDM when applicable.
Name string
User/Group's name.
OverwriteLocalUser bool
Allow overwriting auto-created role binding on NSX for local users
PolicyUserManagementRoleBindingId string
ID of the resource.
Tags List<PolicyUserManagementRoleBindingTag>
A list of scope + tag pairs to associate with this resource.
RolesForPaths This property is required. []PolicyUserManagementRoleBindingRolesForPathArgs
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.
Type This property is required. string
Indicates the type of the user. Valid options:
Description string
Description of the resource.
DisplayName string
Display name of the resource.
IdentitySourceId string
The ID of the external identity source that holds the referenced external entity. Currently, only external LDAP and OIDC servers are allowed.
IdentitySourceType string
Identity source type. Applicable only to remote_user and remote_group user types. Valid options are: VIDM, LDAP, OIDC, CSP. Defaults to VIDM when applicable.
Name string
User/Group's name.
OverwriteLocalUser bool
Allow overwriting auto-created role binding on NSX for local users
PolicyUserManagementRoleBindingId string
ID of the resource.
Tags []PolicyUserManagementRoleBindingTagArgs
A list of scope + tag pairs to associate with this resource.
rolesForPaths This property is required. List<PolicyUserManagementRoleBindingRolesForPath>
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.
type This property is required. String
Indicates the type of the user. Valid options:
description String
Description of the resource.
displayName String
Display name of the resource.
identitySourceId String
The ID of the external identity source that holds the referenced external entity. Currently, only external LDAP and OIDC servers are allowed.
identitySourceType String
Identity source type. Applicable only to remote_user and remote_group user types. Valid options are: VIDM, LDAP, OIDC, CSP. Defaults to VIDM when applicable.
name String
User/Group's name.
overwriteLocalUser Boolean
Allow overwriting auto-created role binding on NSX for local users
policyUserManagementRoleBindingId String
ID of the resource.
tags List<PolicyUserManagementRoleBindingTag>
A list of scope + tag pairs to associate with this resource.
rolesForPaths This property is required. PolicyUserManagementRoleBindingRolesForPath[]
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.
type This property is required. string
Indicates the type of the user. Valid options:
description string
Description of the resource.
displayName string
Display name of the resource.
identitySourceId string
The ID of the external identity source that holds the referenced external entity. Currently, only external LDAP and OIDC servers are allowed.
identitySourceType string
Identity source type. Applicable only to remote_user and remote_group user types. Valid options are: VIDM, LDAP, OIDC, CSP. Defaults to VIDM when applicable.
name string
User/Group's name.
overwriteLocalUser boolean
Allow overwriting auto-created role binding on NSX for local users
policyUserManagementRoleBindingId string
ID of the resource.
tags PolicyUserManagementRoleBindingTag[]
A list of scope + tag pairs to associate with this resource.
roles_for_paths This property is required. Sequence[PolicyUserManagementRoleBindingRolesForPathArgs]
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.
type This property is required. str
Indicates the type of the user. Valid options:
description str
Description of the resource.
display_name str
Display name of the resource.
identity_source_id str
The ID of the external identity source that holds the referenced external entity. Currently, only external LDAP and OIDC servers are allowed.
identity_source_type str
Identity source type. Applicable only to remote_user and remote_group user types. Valid options are: VIDM, LDAP, OIDC, CSP. Defaults to VIDM when applicable.
name str
User/Group's name.
overwrite_local_user bool
Allow overwriting auto-created role binding on NSX for local users
policy_user_management_role_binding_id str
ID of the resource.
tags Sequence[PolicyUserManagementRoleBindingTagArgs]
A list of scope + tag pairs to associate with this resource.
rolesForPaths This property is required. 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.
type This property is required. String
Indicates the type of the user. Valid options:
description String
Description of the resource.
displayName String
Display name of the resource.
identitySourceId String
The ID of the external identity source that holds the referenced external entity. Currently, only external LDAP and OIDC servers are allowed.
identitySourceType String
Identity source type. Applicable only to remote_user and remote_group user types. Valid options are: VIDM, LDAP, OIDC, CSP. Defaults to VIDM when applicable.
name String
User/Group's name.
overwriteLocalUser Boolean
Allow overwriting auto-created role binding on NSX for local users
policyUserManagementRoleBindingId String
ID of the resource.
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 PolicyUserManagementRoleBinding resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Revision double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
UserId string
Local user's numeric id. Only applicable to local_user.
Id string
The provider-assigned unique ID for this managed resource.
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
UserId string
Local user's numeric id. Only applicable to local_user.
id String
The provider-assigned unique ID for this managed resource.
revision Double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
userId String
Local user's numeric id. Only applicable to local_user.
id string
The provider-assigned unique ID for this managed resource.
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
userId string
Local user's numeric id. Only applicable to local_user.
id str
The provider-assigned unique ID for this managed resource.
revision float
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
user_id str
Local user's numeric id. Only applicable to local_user.
id String
The provider-assigned unique ID for this managed resource.
revision Number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
userId String
Local user's numeric id. Only applicable to local_user.

Look up Existing PolicyUserManagementRoleBinding Resource

Get an existing PolicyUserManagementRoleBinding 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?: PolicyUserManagementRoleBindingState, opts?: CustomResourceOptions): PolicyUserManagementRoleBinding
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        identity_source_id: Optional[str] = None,
        identity_source_type: Optional[str] = None,
        name: Optional[str] = None,
        overwrite_local_user: Optional[bool] = None,
        policy_user_management_role_binding_id: Optional[str] = None,
        revision: Optional[float] = None,
        roles_for_paths: Optional[Sequence[PolicyUserManagementRoleBindingRolesForPathArgs]] = None,
        tags: Optional[Sequence[PolicyUserManagementRoleBindingTagArgs]] = None,
        type: Optional[str] = None,
        user_id: Optional[str] = None) -> PolicyUserManagementRoleBinding
func GetPolicyUserManagementRoleBinding(ctx *Context, name string, id IDInput, state *PolicyUserManagementRoleBindingState, opts ...ResourceOption) (*PolicyUserManagementRoleBinding, error)
public static PolicyUserManagementRoleBinding Get(string name, Input<string> id, PolicyUserManagementRoleBindingState? state, CustomResourceOptions? opts = null)
public static PolicyUserManagementRoleBinding get(String name, Output<String> id, PolicyUserManagementRoleBindingState state, CustomResourceOptions options)
resources:  _:    type: nsxt:PolicyUserManagementRoleBinding    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
Description of the resource.
DisplayName string
Display name of the resource.
IdentitySourceId string
The ID of the external identity source that holds the referenced external entity. Currently, only external LDAP and OIDC servers are allowed.
IdentitySourceType string
Identity source type. Applicable only to remote_user and remote_group user types. Valid options are: VIDM, LDAP, OIDC, CSP. Defaults to VIDM when applicable.
Name string
User/Group's name.
OverwriteLocalUser bool
Allow overwriting auto-created role binding on NSX for local users
PolicyUserManagementRoleBindingId string
ID of the resource.
Revision double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
RolesForPaths List<PolicyUserManagementRoleBindingRolesForPath>
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<PolicyUserManagementRoleBindingTag>
A list of scope + tag pairs to associate with this resource.
Type string
Indicates the type of the user. Valid options:
UserId string
Local user's numeric id. Only applicable to local_user.
Description string
Description of the resource.
DisplayName string
Display name of the resource.
IdentitySourceId string
The ID of the external identity source that holds the referenced external entity. Currently, only external LDAP and OIDC servers are allowed.
IdentitySourceType string
Identity source type. Applicable only to remote_user and remote_group user types. Valid options are: VIDM, LDAP, OIDC, CSP. Defaults to VIDM when applicable.
Name string
User/Group's name.
OverwriteLocalUser bool
Allow overwriting auto-created role binding on NSX for local users
PolicyUserManagementRoleBindingId string
ID of the resource.
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
RolesForPaths []PolicyUserManagementRoleBindingRolesForPathArgs
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 []PolicyUserManagementRoleBindingTagArgs
A list of scope + tag pairs to associate with this resource.
Type string
Indicates the type of the user. Valid options:
UserId string
Local user's numeric id. Only applicable to local_user.
description String
Description of the resource.
displayName String
Display name of the resource.
identitySourceId String
The ID of the external identity source that holds the referenced external entity. Currently, only external LDAP and OIDC servers are allowed.
identitySourceType String
Identity source type. Applicable only to remote_user and remote_group user types. Valid options are: VIDM, LDAP, OIDC, CSP. Defaults to VIDM when applicable.
name String
User/Group's name.
overwriteLocalUser Boolean
Allow overwriting auto-created role binding on NSX for local users
policyUserManagementRoleBindingId String
ID of the resource.
revision Double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
rolesForPaths List<PolicyUserManagementRoleBindingRolesForPath>
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<PolicyUserManagementRoleBindingTag>
A list of scope + tag pairs to associate with this resource.
type String
Indicates the type of the user. Valid options:
userId String
Local user's numeric id. Only applicable to local_user.
description string
Description of the resource.
displayName string
Display name of the resource.
identitySourceId string
The ID of the external identity source that holds the referenced external entity. Currently, only external LDAP and OIDC servers are allowed.
identitySourceType string
Identity source type. Applicable only to remote_user and remote_group user types. Valid options are: VIDM, LDAP, OIDC, CSP. Defaults to VIDM when applicable.
name string
User/Group's name.
overwriteLocalUser boolean
Allow overwriting auto-created role binding on NSX for local users
policyUserManagementRoleBindingId string
ID of the resource.
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
rolesForPaths PolicyUserManagementRoleBindingRolesForPath[]
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 PolicyUserManagementRoleBindingTag[]
A list of scope + tag pairs to associate with this resource.
type string
Indicates the type of the user. Valid options:
userId string
Local user's numeric id. Only applicable to local_user.
description str
Description of the resource.
display_name str
Display name of the resource.
identity_source_id str
The ID of the external identity source that holds the referenced external entity. Currently, only external LDAP and OIDC servers are allowed.
identity_source_type str
Identity source type. Applicable only to remote_user and remote_group user types. Valid options are: VIDM, LDAP, OIDC, CSP. Defaults to VIDM when applicable.
name str
User/Group's name.
overwrite_local_user bool
Allow overwriting auto-created role binding on NSX for local users
policy_user_management_role_binding_id str
ID of the resource.
revision float
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
roles_for_paths Sequence[PolicyUserManagementRoleBindingRolesForPathArgs]
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[PolicyUserManagementRoleBindingTagArgs]
A list of scope + tag pairs to associate with this resource.
type str
Indicates the type of the user. Valid options:
user_id str
Local user's numeric id. Only applicable to local_user.
description String
Description of the resource.
displayName String
Display name of the resource.
identitySourceId String
The ID of the external identity source that holds the referenced external entity. Currently, only external LDAP and OIDC servers are allowed.
identitySourceType String
Identity source type. Applicable only to remote_user and remote_group user types. Valid options are: VIDM, LDAP, OIDC, CSP. Defaults to VIDM when applicable.
name String
User/Group's name.
overwriteLocalUser Boolean
Allow overwriting auto-created role binding on NSX for local users
policyUserManagementRoleBindingId String
ID of the resource.
revision Number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
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.
type String
Indicates the type of the user. Valid options:
userId String
Local user's numeric id. Only applicable to local_user.

Supporting Types

PolicyUserManagementRoleBindingRolesForPath
, PolicyUserManagementRoleBindingRolesForPathArgs

Path This property is required. string
Path of the entity in parent hierarchy.
Roles This property is required. List<string>
A list of identifiers for the roles to associate with the given user limited to a path.
Path This property is required. string
Path of the entity in parent hierarchy.
Roles This property is required. []string
A list of identifiers for the roles to associate with the given user limited to a path.
path This property is required. String
Path of the entity in parent hierarchy.
roles This property is required. List<String>
A list of identifiers for the roles to associate with the given user limited to a path.
path This property is required. string
Path of the entity in parent hierarchy.
roles This property is required. string[]
A list of identifiers for the roles to associate with the given user limited to a path.
path This property is required. str
Path of the entity in parent hierarchy.
roles This property is required. Sequence[str]
A list of identifiers for the roles to associate with the given user limited to a path.
path This property is required. String
Path of the entity in parent hierarchy.
roles This property is required. List<String>
A list of identifiers for the roles to associate with the given user limited to a path.

PolicyUserManagementRoleBindingTag
, PolicyUserManagementRoleBindingTagArgs

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.