@twingate/pulumi-twingate/twingateUser.d.ts

A Pulumi package for creating and managing Twingate cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Users provides different levels of write capabilities across the Twingate Admin Console. For more information, see Twingate's [documentation](https://www.twingate.com/docs/users).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as twingate from "@twingate/pulumi-twingate";
 *
 * const user = new twingate.TwingateUser("user", {
 *     email: "sample@company.com",
 *     firstName: "Twin",
 *     lastName: "Gate",
 *     role: "DEVOPS",
 * });
 * ```
 *
 * ## Import
 *
 * ```sh
 * $ pulumi import twingate:index/twingateUser:TwingateUser user VXNlcjo1ODk3MTM=
 * ```
 */
export declare class TwingateUser extends pulumi.CustomResource {
    /**
     * Get an existing TwingateUser 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?: TwingateUserState, opts?: pulumi.CustomResourceOptions): TwingateUser;
    /**
     * Returns true if the given object is an instance of TwingateUser.  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 TwingateUser;
    /**
     * The User's email address
     */
    readonly email: pulumi.Output<string>;
    /**
     * The User's first name
     */
    readonly firstName: pulumi.Output<string>;
    /**
     * Determines whether the User is active or not. Inactive users will be not able to sign in.
     */
    readonly isActive: pulumi.Output<boolean>;
    /**
     * The User's last name
     */
    readonly lastName: pulumi.Output<string>;
    /**
     * Determines the User's role. Either ADMIN, DEVOPS, SUPPORT, MEMBER or ACCESS_REVIEWER.
     */
    readonly role: pulumi.Output<string>;
    /**
     * Determines whether to send an email invitation to the User. True by default.
     *
     * @deprecated This attribute is no longer used and will be removed in a future release.
     */
    readonly sendInvite: pulumi.Output<boolean>;
    /**
     * Indicates the User's type. Either MANUAL or SYNCED.
     */
    readonly type: pulumi.Output<string>;
    /**
     * Create a TwingateUser 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: TwingateUserArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering TwingateUser resources.
 */
export interface TwingateUserState {
    /**
     * The User's email address
     */
    email?: pulumi.Input<string>;
    /**
     * The User's first name
     */
    firstName?: pulumi.Input<string>;
    /**
     * Determines whether the User is active or not. Inactive users will be not able to sign in.
     */
    isActive?: pulumi.Input<boolean>;
    /**
     * The User's last name
     */
    lastName?: pulumi.Input<string>;
    /**
     * Determines the User's role. Either ADMIN, DEVOPS, SUPPORT, MEMBER or ACCESS_REVIEWER.
     */
    role?: pulumi.Input<string>;
    /**
     * Determines whether to send an email invitation to the User. True by default.
     *
     * @deprecated This attribute is no longer used and will be removed in a future release.
     */
    sendInvite?: pulumi.Input<boolean>;
    /**
     * Indicates the User's type. Either MANUAL or SYNCED.
     */
    type?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a TwingateUser resource.
 */
export interface TwingateUserArgs {
    /**
     * The User's email address
     */
    email: pulumi.Input<string>;
    /**
     * The User's first name
     */
    firstName?: pulumi.Input<string>;
    /**
     * Determines whether the User is active or not. Inactive users will be not able to sign in.
     */
    isActive?: pulumi.Input<boolean>;
    /**
     * The User's last name
     */
    lastName?: pulumi.Input<string>;
    /**
     * Determines the User's role. Either ADMIN, DEVOPS, SUPPORT, MEMBER or ACCESS_REVIEWER.
     */
    role?: pulumi.Input<string>;
    /**
     * Determines whether to send an email invitation to the User. True by default.
     *
     * @deprecated This attribute is no longer used and will be removed in a future release.
     */
    sendInvite?: pulumi.Input<boolean>;
}