@bdzscaler/pulumi-zia/adminUsers.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-administrators)
 * * [API documentation](https://help.zscaler.com/zia/admin-role-management#/adminUsers-get)
 *
 * The **zia_admin_users** resource allows the creation and management of ZIA admin user account created in the Zscaler Internet Access cloud or via the API.
 *
 * ## Example Usage
 *
 * ### Organization Scope
 *
 * ### Department Scope
 *
 * ### Location Scope
 *
 * ### Location Group Scope
 *
 * ## 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_admin_users** can be imported by using `<ADMIN ID>` or `<LOGIN NAME>` as the import ID.
 *
 * For example:
 *
 * ```sh
 * $ pulumi import zia:index/adminUsers:AdminUsers example <admin_id>
 * ```
 *
 * or
 *
 * ```sh
 * $ pulumi import zia:index/adminUsers:AdminUsers example <login_name>
 * ```
 *
 * ⚠️ **NOTE :**:  This provider do not import the password attribute value during the importing process.
 */
export declare class AdminUsers extends pulumi.CustomResource {
    /**
     * Get an existing AdminUsers 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?: AdminUsersState, opts?: pulumi.CustomResourceOptions): AdminUsers;
    /**
     * Returns true if the given object is an instance of AdminUsers.  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 AdminUsers;
    readonly adminId: pulumi.Output<number>;
    /**
     * list of destination ip groups
     */
    readonly adminScopeEntities: pulumi.Output<outputs.AdminUsersAdminScopeEntities | undefined>;
    readonly adminScopeType: pulumi.Output<string>;
    /**
     * Additional information about the admin or auditor.
     */
    readonly comments: pulumi.Output<string | undefined>;
    readonly disabled: pulumi.Output<boolean | undefined>;
    /**
     * Admin or auditor's email address.
     */
    readonly email: pulumi.Output<string>;
    readonly isAuditor: pulumi.Output<boolean | undefined>;
    readonly isExecMobileAppEnabled: pulumi.Output<boolean | undefined>;
    readonly isNonEditable: pulumi.Output<boolean | undefined>;
    readonly isPasswordExpired: pulumi.Output<boolean | undefined>;
    readonly isPasswordLoginAllowed: pulumi.Output<boolean | undefined>;
    readonly isProductUpdateCommEnabled: pulumi.Output<boolean | undefined>;
    readonly isSecurityReportCommEnabled: pulumi.Output<boolean | undefined>;
    readonly isServiceUpdateCommEnabled: pulumi.Output<boolean | undefined>;
    readonly loginName: pulumi.Output<string>;
    /**
     * The admin's password. If admin single sign-on (SSO) is disabled, then this field is mandatory for POST requests. This
     * information is not provided in a GET response.
     */
    readonly password: pulumi.Output<string | undefined>;
    /**
     * Role of the admin. This is not required for an auditor.
     */
    readonly roles: pulumi.Output<outputs.AdminUsersRole[] | undefined>;
    /**
     * Admin or auditor's username.
     */
    readonly username: pulumi.Output<string>;
    /**
     * Create a AdminUsers 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: AdminUsersArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering AdminUsers resources.
 */
export interface AdminUsersState {
    adminId?: pulumi.Input<number>;
    /**
     * list of destination ip groups
     */
    adminScopeEntities?: pulumi.Input<inputs.AdminUsersAdminScopeEntities>;
    adminScopeType?: pulumi.Input<string>;
    /**
     * Additional information about the admin or auditor.
     */
    comments?: pulumi.Input<string>;
    disabled?: pulumi.Input<boolean>;
    /**
     * Admin or auditor's email address.
     */
    email?: pulumi.Input<string>;
    isAuditor?: pulumi.Input<boolean>;
    isExecMobileAppEnabled?: pulumi.Input<boolean>;
    isNonEditable?: pulumi.Input<boolean>;
    isPasswordExpired?: pulumi.Input<boolean>;
    isPasswordLoginAllowed?: pulumi.Input<boolean>;
    isProductUpdateCommEnabled?: pulumi.Input<boolean>;
    isSecurityReportCommEnabled?: pulumi.Input<boolean>;
    isServiceUpdateCommEnabled?: pulumi.Input<boolean>;
    loginName?: pulumi.Input<string>;
    /**
     * The admin's password. If admin single sign-on (SSO) is disabled, then this field is mandatory for POST requests. This
     * information is not provided in a GET response.
     */
    password?: pulumi.Input<string>;
    /**
     * Role of the admin. This is not required for an auditor.
     */
    roles?: pulumi.Input<pulumi.Input<inputs.AdminUsersRole>[]>;
    /**
     * Admin or auditor's username.
     */
    username?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a AdminUsers resource.
 */
export interface AdminUsersArgs {
    /**
     * list of destination ip groups
     */
    adminScopeEntities?: pulumi.Input<inputs.AdminUsersAdminScopeEntities>;
    adminScopeType?: pulumi.Input<string>;
    /**
     * Additional information about the admin or auditor.
     */
    comments?: pulumi.Input<string>;
    disabled?: pulumi.Input<boolean>;
    /**
     * Admin or auditor's email address.
     */
    email: pulumi.Input<string>;
    isAuditor?: pulumi.Input<boolean>;
    isExecMobileAppEnabled?: pulumi.Input<boolean>;
    isNonEditable?: pulumi.Input<boolean>;
    isPasswordExpired?: pulumi.Input<boolean>;
    isPasswordLoginAllowed?: pulumi.Input<boolean>;
    isProductUpdateCommEnabled?: pulumi.Input<boolean>;
    isSecurityReportCommEnabled?: pulumi.Input<boolean>;
    isServiceUpdateCommEnabled?: pulumi.Input<boolean>;
    loginName: pulumi.Input<string>;
    /**
     * The admin's password. If admin single sign-on (SSO) is disabled, then this field is mandatory for POST requests. This
     * information is not provided in a GET response.
     */
    password?: pulumi.Input<string>;
    /**
     * Role of the admin. This is not required for an auditor.
     */
    roles?: pulumi.Input<pulumi.Input<inputs.AdminUsersRole>[]>;
    /**
     * Admin or auditor's username.
     */
    username: pulumi.Input<string>;
}