1. Packages
  2. Cisco ISE
  3. API Docs
  4. identitymanagement
  5. InternalUser
Cisco ISE v0.1.10 published on Tuesday, Nov 19, 2024 by Pulumi

ise.identitymanagement.InternalUser

Explore with Pulumi AI

ise logo
Cisco ISE v0.1.10 published on Tuesday, Nov 19, 2024 by Pulumi

    This resource can manage an Internal User.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ise from "@pulumi/ise";
    
    const example = new ise.identitymanagement.InternalUser("example", {
        name: "UserTF",
        password: "Cisco123",
        changePassword: true,
        email: "aaa@cisco.com",
        accountNameAlias: "User 1",
        enablePassword: "Cisco123",
        enabled: true,
        passwordNeverExpires: false,
        firstName: "John",
        lastName: "Doe",
        passwordIdStore: "Internal Users",
        description: "My first Terraform user",
    });
    
    import pulumi
    import pulumi_ise as ise
    
    example = ise.identitymanagement.InternalUser("example",
        name="UserTF",
        password="Cisco123",
        change_password=True,
        email="aaa@cisco.com",
        account_name_alias="User 1",
        enable_password="Cisco123",
        enabled=True,
        password_never_expires=False,
        first_name="John",
        last_name="Doe",
        password_id_store="Internal Users",
        description="My first Terraform user")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-ise/sdk/go/ise/identitymanagement"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := identitymanagement.NewInternalUser(ctx, "example", &identitymanagement.InternalUserArgs{
    			Name:                 pulumi.String("UserTF"),
    			Password:             pulumi.String("Cisco123"),
    			ChangePassword:       pulumi.Bool(true),
    			Email:                pulumi.String("aaa@cisco.com"),
    			AccountNameAlias:     pulumi.String("User 1"),
    			EnablePassword:       pulumi.String("Cisco123"),
    			Enabled:              pulumi.Bool(true),
    			PasswordNeverExpires: pulumi.Bool(false),
    			FirstName:            pulumi.String("John"),
    			LastName:             pulumi.String("Doe"),
    			PasswordIdStore:      pulumi.String("Internal Users"),
    			Description:          pulumi.String("My first Terraform user"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ise = Pulumi.Ise;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Ise.IdentityManagement.InternalUser("example", new()
        {
            Name = "UserTF",
            Password = "Cisco123",
            ChangePassword = true,
            Email = "aaa@cisco.com",
            AccountNameAlias = "User 1",
            EnablePassword = "Cisco123",
            Enabled = true,
            PasswordNeverExpires = false,
            FirstName = "John",
            LastName = "Doe",
            PasswordIdStore = "Internal Users",
            Description = "My first Terraform user",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ise.identitymanagement.InternalUser;
    import com.pulumi.ise.identitymanagement.InternalUserArgs;
    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) {
            var example = new InternalUser("example", InternalUserArgs.builder()
                .name("UserTF")
                .password("Cisco123")
                .changePassword(true)
                .email("aaa@cisco.com")
                .accountNameAlias("User 1")
                .enablePassword("Cisco123")
                .enabled(true)
                .passwordNeverExpires(false)
                .firstName("John")
                .lastName("Doe")
                .passwordIdStore("Internal Users")
                .description("My first Terraform user")
                .build());
    
        }
    }
    
    resources:
      example:
        type: ise:identitymanagement:InternalUser
        properties:
          name: UserTF
          password: Cisco123
          changePassword: true
          email: aaa@cisco.com
          accountNameAlias: User 1
          enablePassword: Cisco123
          enabled: true
          passwordNeverExpires: false
          firstName: John
          lastName: Doe
          passwordIdStore: Internal Users
          description: My first Terraform user
    

    Create InternalUser Resource

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

    Constructor syntax

    new InternalUser(name: string, args: InternalUserArgs, opts?: CustomResourceOptions);
    @overload
    def InternalUser(resource_name: str,
                     args: InternalUserArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def InternalUser(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     password: Optional[str] = None,
                     enabled: Optional[bool] = None,
                     custom_attributes: Optional[str] = None,
                     description: Optional[str] = None,
                     email: Optional[str] = None,
                     enable_password: Optional[str] = None,
                     account_name_alias: Optional[str] = None,
                     first_name: Optional[str] = None,
                     identity_groups: Optional[str] = None,
                     last_name: Optional[str] = None,
                     name: Optional[str] = None,
                     change_password: Optional[bool] = None,
                     password_id_store: Optional[str] = None,
                     password_never_expires: Optional[bool] = None)
    func NewInternalUser(ctx *Context, name string, args InternalUserArgs, opts ...ResourceOption) (*InternalUser, error)
    public InternalUser(string name, InternalUserArgs args, CustomResourceOptions? opts = null)
    public InternalUser(String name, InternalUserArgs args)
    public InternalUser(String name, InternalUserArgs args, CustomResourceOptions options)
    
    type: ise:identitymanagement:InternalUser
    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 InternalUserArgs
    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 InternalUserArgs
    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 InternalUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InternalUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InternalUserArgs
    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 internalUserResource = new Ise.IdentityManagement.InternalUser("internalUserResource", new()
    {
        Password = "string",
        Enabled = false,
        CustomAttributes = "string",
        Description = "string",
        Email = "string",
        EnablePassword = "string",
        AccountNameAlias = "string",
        FirstName = "string",
        IdentityGroups = "string",
        LastName = "string",
        Name = "string",
        ChangePassword = false,
        PasswordIdStore = "string",
        PasswordNeverExpires = false,
    });
    
    example, err := identitymanagement.NewInternalUser(ctx, "internalUserResource", &identitymanagement.InternalUserArgs{
    	Password:             pulumi.String("string"),
    	Enabled:              pulumi.Bool(false),
    	CustomAttributes:     pulumi.String("string"),
    	Description:          pulumi.String("string"),
    	Email:                pulumi.String("string"),
    	EnablePassword:       pulumi.String("string"),
    	AccountNameAlias:     pulumi.String("string"),
    	FirstName:            pulumi.String("string"),
    	IdentityGroups:       pulumi.String("string"),
    	LastName:             pulumi.String("string"),
    	Name:                 pulumi.String("string"),
    	ChangePassword:       pulumi.Bool(false),
    	PasswordIdStore:      pulumi.String("string"),
    	PasswordNeverExpires: pulumi.Bool(false),
    })
    
    var internalUserResource = new InternalUser("internalUserResource", InternalUserArgs.builder()
        .password("string")
        .enabled(false)
        .customAttributes("string")
        .description("string")
        .email("string")
        .enablePassword("string")
        .accountNameAlias("string")
        .firstName("string")
        .identityGroups("string")
        .lastName("string")
        .name("string")
        .changePassword(false)
        .passwordIdStore("string")
        .passwordNeverExpires(false)
        .build());
    
    internal_user_resource = ise.identitymanagement.InternalUser("internalUserResource",
        password="string",
        enabled=False,
        custom_attributes="string",
        description="string",
        email="string",
        enable_password="string",
        account_name_alias="string",
        first_name="string",
        identity_groups="string",
        last_name="string",
        name="string",
        change_password=False,
        password_id_store="string",
        password_never_expires=False)
    
    const internalUserResource = new ise.identitymanagement.InternalUser("internalUserResource", {
        password: "string",
        enabled: false,
        customAttributes: "string",
        description: "string",
        email: "string",
        enablePassword: "string",
        accountNameAlias: "string",
        firstName: "string",
        identityGroups: "string",
        lastName: "string",
        name: "string",
        changePassword: false,
        passwordIdStore: "string",
        passwordNeverExpires: false,
    });
    
    type: ise:identitymanagement:InternalUser
    properties:
        accountNameAlias: string
        changePassword: false
        customAttributes: string
        description: string
        email: string
        enablePassword: string
        enabled: false
        firstName: string
        identityGroups: string
        lastName: string
        name: string
        password: string
        passwordIdStore: string
        passwordNeverExpires: false
    

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

    Password string
    The password of the internal user
    AccountNameAlias string
    The Account Name Alias will be used to send email notifications about password expiration. This field is only supported from ISE 3.2.
    ChangePassword bool
    Requires the user to change the password - Default value: true
    CustomAttributes string
    Key value map
    Description string
    Description
    Email string
    Email address
    EnablePassword string
    This field is added in ISE 2.0 to support TACACS+
    Enabled bool
    Whether the user is enabled/disabled
    FirstName string
    First name of the internal user
    IdentityGroups string
    Comma separated list of identity group IDs.
    LastName string
    Last name of the internal user
    Name string
    The name of the internal user
    PasswordIdStore string
    The ID store where the internal user's password is kept - Default value: Internal Users
    PasswordNeverExpires bool
    Set to true to indicate the user password never expires. This will not apply to Users who are also ISE Admins. This field is only supported from ISE 3.2. - Default value: false
    Password string
    The password of the internal user
    AccountNameAlias string
    The Account Name Alias will be used to send email notifications about password expiration. This field is only supported from ISE 3.2.
    ChangePassword bool
    Requires the user to change the password - Default value: true
    CustomAttributes string
    Key value map
    Description string
    Description
    Email string
    Email address
    EnablePassword string
    This field is added in ISE 2.0 to support TACACS+
    Enabled bool
    Whether the user is enabled/disabled
    FirstName string
    First name of the internal user
    IdentityGroups string
    Comma separated list of identity group IDs.
    LastName string
    Last name of the internal user
    Name string
    The name of the internal user
    PasswordIdStore string
    The ID store where the internal user's password is kept - Default value: Internal Users
    PasswordNeverExpires bool
    Set to true to indicate the user password never expires. This will not apply to Users who are also ISE Admins. This field is only supported from ISE 3.2. - Default value: false
    password String
    The password of the internal user
    accountNameAlias String
    The Account Name Alias will be used to send email notifications about password expiration. This field is only supported from ISE 3.2.
    changePassword Boolean
    Requires the user to change the password - Default value: true
    customAttributes String
    Key value map
    description String
    Description
    email String
    Email address
    enablePassword String
    This field is added in ISE 2.0 to support TACACS+
    enabled Boolean
    Whether the user is enabled/disabled
    firstName String
    First name of the internal user
    identityGroups String
    Comma separated list of identity group IDs.
    lastName String
    Last name of the internal user
    name String
    The name of the internal user
    passwordIdStore String
    The ID store where the internal user's password is kept - Default value: Internal Users
    passwordNeverExpires Boolean
    Set to true to indicate the user password never expires. This will not apply to Users who are also ISE Admins. This field is only supported from ISE 3.2. - Default value: false
    password string
    The password of the internal user
    accountNameAlias string
    The Account Name Alias will be used to send email notifications about password expiration. This field is only supported from ISE 3.2.
    changePassword boolean
    Requires the user to change the password - Default value: true
    customAttributes string
    Key value map
    description string
    Description
    email string
    Email address
    enablePassword string
    This field is added in ISE 2.0 to support TACACS+
    enabled boolean
    Whether the user is enabled/disabled
    firstName string
    First name of the internal user
    identityGroups string
    Comma separated list of identity group IDs.
    lastName string
    Last name of the internal user
    name string
    The name of the internal user
    passwordIdStore string
    The ID store where the internal user's password is kept - Default value: Internal Users
    passwordNeverExpires boolean
    Set to true to indicate the user password never expires. This will not apply to Users who are also ISE Admins. This field is only supported from ISE 3.2. - Default value: false
    password str
    The password of the internal user
    account_name_alias str
    The Account Name Alias will be used to send email notifications about password expiration. This field is only supported from ISE 3.2.
    change_password bool
    Requires the user to change the password - Default value: true
    custom_attributes str
    Key value map
    description str
    Description
    email str
    Email address
    enable_password str
    This field is added in ISE 2.0 to support TACACS+
    enabled bool
    Whether the user is enabled/disabled
    first_name str
    First name of the internal user
    identity_groups str
    Comma separated list of identity group IDs.
    last_name str
    Last name of the internal user
    name str
    The name of the internal user
    password_id_store str
    The ID store where the internal user's password is kept - Default value: Internal Users
    password_never_expires bool
    Set to true to indicate the user password never expires. This will not apply to Users who are also ISE Admins. This field is only supported from ISE 3.2. - Default value: false
    password String
    The password of the internal user
    accountNameAlias String
    The Account Name Alias will be used to send email notifications about password expiration. This field is only supported from ISE 3.2.
    changePassword Boolean
    Requires the user to change the password - Default value: true
    customAttributes String
    Key value map
    description String
    Description
    email String
    Email address
    enablePassword String
    This field is added in ISE 2.0 to support TACACS+
    enabled Boolean
    Whether the user is enabled/disabled
    firstName String
    First name of the internal user
    identityGroups String
    Comma separated list of identity group IDs.
    lastName String
    Last name of the internal user
    name String
    The name of the internal user
    passwordIdStore String
    The ID store where the internal user's password is kept - Default value: Internal Users
    passwordNeverExpires Boolean
    Set to true to indicate the user password never expires. This will not apply to Users who are also ISE Admins. This field is only supported from ISE 3.2. - Default value: false

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing InternalUser Resource

    Get an existing InternalUser 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?: InternalUserState, opts?: CustomResourceOptions): InternalUser
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_name_alias: Optional[str] = None,
            change_password: Optional[bool] = None,
            custom_attributes: Optional[str] = None,
            description: Optional[str] = None,
            email: Optional[str] = None,
            enable_password: Optional[str] = None,
            enabled: Optional[bool] = None,
            first_name: Optional[str] = None,
            identity_groups: Optional[str] = None,
            last_name: Optional[str] = None,
            name: Optional[str] = None,
            password: Optional[str] = None,
            password_id_store: Optional[str] = None,
            password_never_expires: Optional[bool] = None) -> InternalUser
    func GetInternalUser(ctx *Context, name string, id IDInput, state *InternalUserState, opts ...ResourceOption) (*InternalUser, error)
    public static InternalUser Get(string name, Input<string> id, InternalUserState? state, CustomResourceOptions? opts = null)
    public static InternalUser get(String name, Output<String> id, InternalUserState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AccountNameAlias string
    The Account Name Alias will be used to send email notifications about password expiration. This field is only supported from ISE 3.2.
    ChangePassword bool
    Requires the user to change the password - Default value: true
    CustomAttributes string
    Key value map
    Description string
    Description
    Email string
    Email address
    EnablePassword string
    This field is added in ISE 2.0 to support TACACS+
    Enabled bool
    Whether the user is enabled/disabled
    FirstName string
    First name of the internal user
    IdentityGroups string
    Comma separated list of identity group IDs.
    LastName string
    Last name of the internal user
    Name string
    The name of the internal user
    Password string
    The password of the internal user
    PasswordIdStore string
    The ID store where the internal user's password is kept - Default value: Internal Users
    PasswordNeverExpires bool
    Set to true to indicate the user password never expires. This will not apply to Users who are also ISE Admins. This field is only supported from ISE 3.2. - Default value: false
    AccountNameAlias string
    The Account Name Alias will be used to send email notifications about password expiration. This field is only supported from ISE 3.2.
    ChangePassword bool
    Requires the user to change the password - Default value: true
    CustomAttributes string
    Key value map
    Description string
    Description
    Email string
    Email address
    EnablePassword string
    This field is added in ISE 2.0 to support TACACS+
    Enabled bool
    Whether the user is enabled/disabled
    FirstName string
    First name of the internal user
    IdentityGroups string
    Comma separated list of identity group IDs.
    LastName string
    Last name of the internal user
    Name string
    The name of the internal user
    Password string
    The password of the internal user
    PasswordIdStore string
    The ID store where the internal user's password is kept - Default value: Internal Users
    PasswordNeverExpires bool
    Set to true to indicate the user password never expires. This will not apply to Users who are also ISE Admins. This field is only supported from ISE 3.2. - Default value: false
    accountNameAlias String
    The Account Name Alias will be used to send email notifications about password expiration. This field is only supported from ISE 3.2.
    changePassword Boolean
    Requires the user to change the password - Default value: true
    customAttributes String
    Key value map
    description String
    Description
    email String
    Email address
    enablePassword String
    This field is added in ISE 2.0 to support TACACS+
    enabled Boolean
    Whether the user is enabled/disabled
    firstName String
    First name of the internal user
    identityGroups String
    Comma separated list of identity group IDs.
    lastName String
    Last name of the internal user
    name String
    The name of the internal user
    password String
    The password of the internal user
    passwordIdStore String
    The ID store where the internal user's password is kept - Default value: Internal Users
    passwordNeverExpires Boolean
    Set to true to indicate the user password never expires. This will not apply to Users who are also ISE Admins. This field is only supported from ISE 3.2. - Default value: false
    accountNameAlias string
    The Account Name Alias will be used to send email notifications about password expiration. This field is only supported from ISE 3.2.
    changePassword boolean
    Requires the user to change the password - Default value: true
    customAttributes string
    Key value map
    description string
    Description
    email string
    Email address
    enablePassword string
    This field is added in ISE 2.0 to support TACACS+
    enabled boolean
    Whether the user is enabled/disabled
    firstName string
    First name of the internal user
    identityGroups string
    Comma separated list of identity group IDs.
    lastName string
    Last name of the internal user
    name string
    The name of the internal user
    password string
    The password of the internal user
    passwordIdStore string
    The ID store where the internal user's password is kept - Default value: Internal Users
    passwordNeverExpires boolean
    Set to true to indicate the user password never expires. This will not apply to Users who are also ISE Admins. This field is only supported from ISE 3.2. - Default value: false
    account_name_alias str
    The Account Name Alias will be used to send email notifications about password expiration. This field is only supported from ISE 3.2.
    change_password bool
    Requires the user to change the password - Default value: true
    custom_attributes str
    Key value map
    description str
    Description
    email str
    Email address
    enable_password str
    This field is added in ISE 2.0 to support TACACS+
    enabled bool
    Whether the user is enabled/disabled
    first_name str
    First name of the internal user
    identity_groups str
    Comma separated list of identity group IDs.
    last_name str
    Last name of the internal user
    name str
    The name of the internal user
    password str
    The password of the internal user
    password_id_store str
    The ID store where the internal user's password is kept - Default value: Internal Users
    password_never_expires bool
    Set to true to indicate the user password never expires. This will not apply to Users who are also ISE Admins. This field is only supported from ISE 3.2. - Default value: false
    accountNameAlias String
    The Account Name Alias will be used to send email notifications about password expiration. This field is only supported from ISE 3.2.
    changePassword Boolean
    Requires the user to change the password - Default value: true
    customAttributes String
    Key value map
    description String
    Description
    email String
    Email address
    enablePassword String
    This field is added in ISE 2.0 to support TACACS+
    enabled Boolean
    Whether the user is enabled/disabled
    firstName String
    First name of the internal user
    identityGroups String
    Comma separated list of identity group IDs.
    lastName String
    Last name of the internal user
    name String
    The name of the internal user
    password String
    The password of the internal user
    passwordIdStore String
    The ID store where the internal user's password is kept - Default value: Internal Users
    passwordNeverExpires Boolean
    Set to true to indicate the user password never expires. This will not apply to Users who are also ISE Admins. This field is only supported from ISE 3.2. - Default value: false

    Import

    $ pulumi import ise:identitymanagement/internalUser:InternalUser example "76d24097-41c4-4558-a4d0-a8c07ac08470"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    ise pulumi/pulumi-ise
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ise Terraform Provider.
    ise logo
    Cisco ISE v0.1.10 published on Tuesday, Nov 19, 2024 by Pulumi