@bdzscaler/pulumi-zia/userManagement.d.ts

A Pulumi package for creating and managing zia cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * * [Official documentation](https://help.zscaler.com/zia/about-url-filtering)
 * * [API documentation](https://help.zscaler.com/zia/url-filtering-policy#/urlFilteringRules-post)
 *
 * The **zia_user_management** resource allows the creation and management of local user account in the Zscaler Internet Access cloud. The user account resource can then be associated with several different types of resource within the ZIA tenant.
 *
 * ## Example Usage
 *
 * ## Optional
 *
 * The following attributes are supported:
 *
 * * `comments` - (Optional) Additional information about this user.
 * * `tempAuthEmail` - (Optional) Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler service sends the tokens or links. If this is empty, the service will send the email to the User email.
 * * `authMethods` - (Optional) Type of authentication method to be enabled. Supported values is: ``BASIC``
 *
 * ## Import
 *
 * Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZIA configurations into Terraform-compliant HashiCorp Configuration Language.
 *
 * Visit
 *
 * **zia_user_management** can be imported by using `<USER_ID>` or `<USERNAME>` as the import ID.
 *
 * For example:
 *
 * ```sh
 * $ pulumi import zia:index/userManagement:UserManagement example <user_id>
 * ```
 *
 * or
 *
 * ```sh
 * $ pulumi import zia:index/userManagement:UserManagement example <name>
 * ```
 *
 * ⚠️ **NOTE :**:  This provider do not import the password attribute value during the importing process.
 */
export declare class UserManagement extends pulumi.CustomResource {
    /**
     * Get an existing UserManagement resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UserManagementState, opts?: pulumi.CustomResourceOptions): UserManagement;
    /**
     * Returns true if the given object is an instance of UserManagement.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is UserManagement;
    /**
     * Accepted Authentication Methods
     */
    readonly authMethods: pulumi.Output<string[] | undefined>;
    /**
     * Additional information about this user.
     */
    readonly comments: pulumi.Output<string | undefined>;
    /**
     * Department a user belongs to
     */
    readonly department: pulumi.Output<outputs.UserManagementDepartment>;
    /**
     * User email consists of a user name and domain name. It does not have to be a valid email address, but it must be unique and its domain must belong to the organization.
     */
    readonly email: pulumi.Output<string>;
    /**
     * List of Groups a user belongs to. Groups are used in policies.
     */
    readonly groups: pulumi.Output<outputs.UserManagementGroups | undefined>;
    /**
     * User name. This appears when choosing users for policies.
     */
    readonly name: pulumi.Output<string>;
    /**
     * User's password. Applicable only when authentication type is Hosted DB. Password strength must follow what is defined in the auth settings.
     */
    readonly password: pulumi.Output<string>;
    /**
     * Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler
     * service sends the tokens or links. If this is empty, the service will send the email to the User email.
     */
    readonly tempAuthEmail: pulumi.Output<string | undefined>;
    readonly userId: pulumi.Output<number>;
    /**
     * Create a UserManagement resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: UserManagementArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering UserManagement resources.
 */
export interface UserManagementState {
    /**
     * Accepted Authentication Methods
     */
    authMethods?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Additional information about this user.
     */
    comments?: pulumi.Input<string>;
    /**
     * Department a user belongs to
     */
    department?: pulumi.Input<inputs.UserManagementDepartment>;
    /**
     * User email consists of a user name and domain name. It does not have to be a valid email address, but it must be unique and its domain must belong to the organization.
     */
    email?: pulumi.Input<string>;
    /**
     * List of Groups a user belongs to. Groups are used in policies.
     */
    groups?: pulumi.Input<inputs.UserManagementGroups>;
    /**
     * User name. This appears when choosing users for policies.
     */
    name?: pulumi.Input<string>;
    /**
     * User's password. Applicable only when authentication type is Hosted DB. Password strength must follow what is defined in the auth settings.
     */
    password?: pulumi.Input<string>;
    /**
     * Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler
     * service sends the tokens or links. If this is empty, the service will send the email to the User email.
     */
    tempAuthEmail?: pulumi.Input<string>;
    userId?: pulumi.Input<number>;
}
/**
 * The set of arguments for constructing a UserManagement resource.
 */
export interface UserManagementArgs {
    /**
     * Accepted Authentication Methods
     */
    authMethods?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Additional information about this user.
     */
    comments?: pulumi.Input<string>;
    /**
     * Department a user belongs to
     */
    department: pulumi.Input<inputs.UserManagementDepartment>;
    /**
     * User email consists of a user name and domain name. It does not have to be a valid email address, but it must be unique and its domain must belong to the organization.
     */
    email: pulumi.Input<string>;
    /**
     * List of Groups a user belongs to. Groups are used in policies.
     */
    groups?: pulumi.Input<inputs.UserManagementGroups>;
    /**
     * User name. This appears when choosing users for policies.
     */
    name?: pulumi.Input<string>;
    /**
     * User's password. Applicable only when authentication type is Hosted DB. Password strength must follow what is defined in the auth settings.
     */
    password: pulumi.Input<string>;
    /**
     * Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler
     * service sends the tokens or links. If this is empty, the service will send the email to the User email.
     */
    tempAuthEmail?: pulumi.Input<string>;
}