@pulumi/harness
Version:
A Pulumi package for creating and managing Harness resources.
164 lines (163 loc) • 4.96 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for creating a Harness User. This requires your authentication mechanism to be set to SAML, LDAP, or OAuth, and the feature flag AUTO_ACCEPT_SAML_ACCOUNT_INVITES to be enabled.
*
* ## Import
*
* The `pulumi import` command can be used, for example:
*
* Import account level
*
* ```sh
* $ pulumi import harness:platform/user:User john_doe <email_id>
* ```
*
* Import org level
*
* ```sh
* $ pulumi import harness:platform/user:User john_doe <email_id>/<org_id>
* ```
*
* Import project level
*
* ```sh
* $ pulumi import harness:platform/user:User john_doe <email_id>/<org_id>/<project_id>
* ```
*/
export declare class User extends pulumi.CustomResource {
/**
* Get an existing User 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?: UserState, opts?: pulumi.CustomResourceOptions): User;
/**
* Returns true if the given object is an instance of User. 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 User;
/**
* Whether or not the user account is disabled.
*/
readonly disabled: pulumi.Output<boolean>;
/**
* The email of the user.
*/
readonly email: pulumi.Output<string>;
/**
* Whether or not the user account is externally managed.
*/
readonly externallyManaged: pulumi.Output<boolean>;
/**
* Unique identifier of the user.
*/
readonly identifier: pulumi.Output<string>;
/**
* Whether or not the user account is locked.
*/
readonly locked: pulumi.Output<boolean>;
/**
* Name of the user.
*/
readonly name: pulumi.Output<string>;
/**
* Organization identifier of the user.
*/
readonly orgId: pulumi.Output<string | undefined>;
/**
* Project identifier of the user.
*/
readonly projectId: pulumi.Output<string | undefined>;
/**
* Role Bindings of the user. Cannot be updated.
*/
readonly roleBindings: pulumi.Output<outputs.platform.UserRoleBinding[] | undefined>;
/**
* The user group of the user. Cannot be updated.
*/
readonly userGroups: pulumi.Output<string[]>;
/**
* Create a User 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: UserArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering User resources.
*/
export interface UserState {
/**
* Whether or not the user account is disabled.
*/
disabled?: pulumi.Input<boolean>;
/**
* The email of the user.
*/
email?: pulumi.Input<string>;
/**
* Whether or not the user account is externally managed.
*/
externallyManaged?: pulumi.Input<boolean>;
/**
* Unique identifier of the user.
*/
identifier?: pulumi.Input<string>;
/**
* Whether or not the user account is locked.
*/
locked?: pulumi.Input<boolean>;
/**
* Name of the user.
*/
name?: pulumi.Input<string>;
/**
* Organization identifier of the user.
*/
orgId?: pulumi.Input<string>;
/**
* Project identifier of the user.
*/
projectId?: pulumi.Input<string>;
/**
* Role Bindings of the user. Cannot be updated.
*/
roleBindings?: pulumi.Input<pulumi.Input<inputs.platform.UserRoleBinding>[]>;
/**
* The user group of the user. Cannot be updated.
*/
userGroups?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a User resource.
*/
export interface UserArgs {
/**
* The email of the user.
*/
email: pulumi.Input<string>;
/**
* Organization identifier of the user.
*/
orgId?: pulumi.Input<string>;
/**
* Project identifier of the user.
*/
projectId?: pulumi.Input<string>;
/**
* Role Bindings of the user. Cannot be updated.
*/
roleBindings?: pulumi.Input<pulumi.Input<inputs.platform.UserRoleBinding>[]>;
/**
* The user group of the user. Cannot be updated.
*/
userGroups: pulumi.Input<pulumi.Input<string>[]>;
}