1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. UserManagementUser
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

zia.UserManagementUser

zia logo
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

    The zia.UserManagementUser resource manages user accounts in the Zscaler Internet Access (ZIA) cloud. Users can be assigned to departments and groups, and enrolled with authentication methods such as BASIC or DIGEST.

    Example Usage

    Basic User Management

    Example coming soon!

    Example coming soon!

    Example coming soon!

    import * as zia from "@bdzscaler/pulumi-zia";

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

const cfg = new pulumi.Config();
const userPassword = cfg.requireSecret("userPassword");

const example = new zia.UserManagementUser("example", {
    name: "John Doe",
    email: "john.doe@example.com",
    password: userPassword,
    authMethods: ["BASIC"],
    groups: [12345],
    department: {
        id: 67890,
    },
});

    import zscaler_pulumi_zia as zia

cfg = pulumi.Config()
user_password = cfg.require_secret("userPassword")

example = zia.UserManagementUser("example",
    name="John Doe",
    email="john.doe@example.com",
    password=user_password,
    auth_methods=["BASIC"],
    groups=[12345],
    department={
        "id": 67890,
    },
)

    resources:
  example:
    type: zia:UserManagementUser
    properties:
      name: John Doe
      email: john.doe@example.com
      password:
        fn::secret: ${userPassword}
      authMethods:
        - BASIC
      groups:
        - 12345
      department:
        id: 67890

    Create UserManagementUser Resource

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

    Constructor syntax

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

@overload
def UserManagementUser(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       email: Optional[str] = None,
                       name: Optional[str] = None,
                       password: Optional[str] = None,
                       auth_methods: Optional[Sequence[str]] = None,
                       comments: Optional[str] = None,
                       department: Optional[UserDepartmentInputArgs] = None,
                       groups: Optional[Sequence[int]] = None,
                       temp_auth_email: Optional[str] = None)
    func NewUserManagementUser(ctx *Context, name string, args UserManagementUserArgs, opts ...ResourceOption) (*UserManagementUser, error)
    public UserManagementUser(string name, UserManagementUserArgs args, CustomResourceOptions? opts = null)
    public UserManagementUser(String name, UserManagementUserArgs args)
public UserManagementUser(String name, UserManagementUserArgs args, CustomResourceOptions options)

    type: zia:UserManagementUser
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 UserManagementUserArgs
    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 UserManagementUserArgs
    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 UserManagementUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserManagementUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserManagementUserArgs
    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 userManagementUserResource = new Zia.UserManagementUser("userManagementUserResource", new()
{
    Email = "string",
    Name = "string",
    Password = "string",
    AuthMethods = new[]
    {
        "string",
    },
    Comments = "string",
    Department = new Zia.Inputs.UserDepartmentInputArgs
    {
        Comments = "string",
        Deleted = false,
        Id = 0,
        IdpId = 0,
        Name = "string",
    },
    Groups = new[]
    {
        0,
    },
    TempAuthEmail = "string",
});

    example, err := zia.NewUserManagementUser(ctx, "userManagementUserResource", &zia.UserManagementUserArgs{
	Email:    pulumi.String("string"),
	Name:     pulumi.String("string"),
	Password: pulumi.String("string"),
	AuthMethods: pulumi.StringArray{
		pulumi.String("string"),
	},
	Comments: pulumi.String("string"),
	Department: &pulumizia.UserDepartmentInputArgs{
		Comments: pulumi.String("string"),
		Deleted:  pulumi.Bool(false),
		Id:       pulumi.Int(0),
		IdpId:    pulumi.Int(0),
		Name:     pulumi.String("string"),
	},
	Groups: pulumi.IntArray{
		pulumi.Int(0),
	},
	TempAuthEmail: pulumi.String("string"),
})

    var userManagementUserResource = new UserManagementUser("userManagementUserResource", UserManagementUserArgs.builder()
    .email("string")
    .name("string")
    .password("string")
    .authMethods("string")
    .comments("string")
    .department(UserDepartmentInputArgs.builder()
        .comments("string")
        .deleted(false)
        .id(0)
        .idpId(0)
        .name("string")
        .build())
    .groups(0)
    .tempAuthEmail("string")
    .build());

    user_management_user_resource = zia.UserManagementUser("userManagementUserResource",
    email="string",
    name="string",
    password="string",
    auth_methods=["string"],
    comments="string",
    department={
        "comments": "string",
        "deleted": False,
        "id": 0,
        "idp_id": 0,
        "name": "string",
    },
    groups=[0],
    temp_auth_email="string")

    const userManagementUserResource = new zia.UserManagementUser("userManagementUserResource", {
    email: "string",
    name: "string",
    password: "string",
    authMethods: ["string"],
    comments: "string",
    department: {
        comments: "string",
        deleted: false,
        id: 0,
        idpId: 0,
        name: "string",
    },
    groups: [0],
    tempAuthEmail: "string",
});

    type: zia:UserManagementUser
properties:
    authMethods:
        - string
    comments: string
    department:
        comments: string
        deleted: false
        id: 0
        idpId: 0
        name: string
    email: string
    groups:
        - 0
    name: string
    password: string
    tempAuthEmail: string

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

    Email string
    The user's email address. Maximum 127 characters.
    Name string
    The user's full name. Maximum 127 characters.
    Password string
    The user's password. This is a secret and will not be stored in plaintext in the state.
    AuthMethods List<string>
    Authentication methods for the user. Accepted values: 'BASIC', 'DIGEST'.
    Comments string
    Comments or notes about the user. Maximum 10240 characters.
    Department zscaler.PulumiPackage.Zia.Inputs.UserDepartmentInput
    The department the user belongs to.
    Groups List<int>
    List of group IDs the user belongs to.
    TempAuthEmail string
    Temporary authentication email for the user.
    Email string
    The user's email address. Maximum 127 characters.
    Name string
    The user's full name. Maximum 127 characters.
    Password string
    The user's password. This is a secret and will not be stored in plaintext in the state.
    AuthMethods []string
    Authentication methods for the user. Accepted values: 'BASIC', 'DIGEST'.
    Comments string
    Comments or notes about the user. Maximum 10240 characters.
    Department UserDepartmentInputArgs
    The department the user belongs to.
    Groups []int
    List of group IDs the user belongs to.
    TempAuthEmail string
    Temporary authentication email for the user.
    email String
    The user's email address. Maximum 127 characters.
    name String
    The user's full name. Maximum 127 characters.
    password String
    The user's password. This is a secret and will not be stored in plaintext in the state.
    authMethods List<String>
    Authentication methods for the user. Accepted values: 'BASIC', 'DIGEST'.
    comments String
    Comments or notes about the user. Maximum 10240 characters.
    department UserDepartmentInput
    The department the user belongs to.
    groups List<Integer>
    List of group IDs the user belongs to.
    tempAuthEmail String
    Temporary authentication email for the user.
    email string
    The user's email address. Maximum 127 characters.
    name string
    The user's full name. Maximum 127 characters.
    password string
    The user's password. This is a secret and will not be stored in plaintext in the state.
    authMethods string[]
    Authentication methods for the user. Accepted values: 'BASIC', 'DIGEST'.
    comments string
    Comments or notes about the user. Maximum 10240 characters.
    department UserDepartmentInput
    The department the user belongs to.
    groups number[]
    List of group IDs the user belongs to.
    tempAuthEmail string
    Temporary authentication email for the user.
    email str
    The user's email address. Maximum 127 characters.
    name str
    The user's full name. Maximum 127 characters.
    password str
    The user's password. This is a secret and will not be stored in plaintext in the state.
    auth_methods Sequence[str]
    Authentication methods for the user. Accepted values: 'BASIC', 'DIGEST'.
    comments str
    Comments or notes about the user. Maximum 10240 characters.
    department UserDepartmentInputArgs
    The department the user belongs to.
    groups Sequence[int]
    List of group IDs the user belongs to.
    temp_auth_email str
    Temporary authentication email for the user.
    email String
    The user's email address. Maximum 127 characters.
    name String
    The user's full name. Maximum 127 characters.
    password String
    The user's password. This is a secret and will not be stored in plaintext in the state.
    authMethods List<String>
    Authentication methods for the user. Accepted values: 'BASIC', 'DIGEST'.
    comments String
    Comments or notes about the user. Maximum 10240 characters.
    department Property Map
    The department the user belongs to.
    groups List<Number>
    List of group IDs the user belongs to.
    tempAuthEmail String
    Temporary authentication email for the user.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    UserId int
    The unique identifier for the user assigned by the ZIA cloud.
    Id string
    The provider-assigned unique ID for this managed resource.
    UserId int
    The unique identifier for the user assigned by the ZIA cloud.
    id String
    The provider-assigned unique ID for this managed resource.
    userId Integer
    The unique identifier for the user assigned by the ZIA cloud.
    id string
    The provider-assigned unique ID for this managed resource.
    userId number
    The unique identifier for the user assigned by the ZIA cloud.
    id str
    The provider-assigned unique ID for this managed resource.
    user_id int
    The unique identifier for the user assigned by the ZIA cloud.
    id String
    The provider-assigned unique ID for this managed resource.
    userId Number
    The unique identifier for the user assigned by the ZIA cloud.

    Supporting Types

    UserDepartmentInput, UserDepartmentInputArgs

    Comments string
    Deleted bool
    Id int
    IdpId int
    Name string
    Comments string
    Deleted bool
    Id int
    IdpId int
    Name string
    comments String
    deleted Boolean
    id Integer
    idpId Integer
    name String
    comments string
    deleted boolean
    id number
    idpId number
    name string
    comments str
    deleted bool
    id int
    idp_id int
    name str
    comments String
    deleted Boolean
    id Number
    idpId Number
    name String

    Import

    An existing user can be imported using its ID, e.g.

    $ pulumi import zia:index:UserManagementUser example 12345

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

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    zia logo
    Viewing docs for pulumi-resource-zia v1.3.8
    published on Friday, Mar 13, 2026 by Zscaler
    Schema (JSON)
    zscaler/pulumi-zia
      Try Pulumi Cloud free. Your team will thank you.