import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Resource for creating a Harness User Group. Linking SSO providers with User Groups: * * The following fields need to be populated for LDAP SSO Providers: * * - linkedSsoId * * - linkedSsoDisplayName * * - ssoGroupId * * - ssoGroupName * * - linkedSsoType * * - ssoLinked * * The following fields need to be populated for SAML SSO Providers: * * - linkedSsoId * * - linkedSsoDisplayName * * - ssoGroupName * * - ssoGroupId // same as ssoGroupName * * - linkedSsoType * * - ssoLinked * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as harness from "@pulumi/harness"; * * const ssoTypeSaml = new harness.platform.Usergroup("sso_type_saml", { * identifier: "identifier", * name: "name", * orgId: "org_id", * projectId: "project_id", * linkedSsoId: "linked_sso_id", * externallyManaged: false, * users: ["user_id"], * notificationConfigs: [ * { * type: "SLACK", * slackWebhookUrl: "https://google.com", * }, * { * type: "EMAIL", * groupEmail: "email@email.com", * sendEmailToAllUsers: true, * }, * { * type: "MSTEAMS", * microsoftTeamsWebhookUrl: "https://google.com", * }, * { * type: "PAGERDUTY", * pagerDutyKey: "pagerDutyKey", * }, * ], * linkedSsoDisplayName: "linked_sso_display_name", * ssoGroupId: "sso_group_name", * ssoGroupName: "sso_group_name", * linkedSsoType: "SAML", * ssoLinked: true, * }); * const ssoTypeLdap = new harness.platform.Usergroup("sso_type_ldap", { * identifier: "identifier", * name: "name", * orgId: "org_id", * projectId: "project_id", * linkedSsoId: "linked_sso_id", * externallyManaged: false, * users: ["user_id"], * notificationConfigs: [ * { * type: "SLACK", * slackWebhookUrl: "https://google.com", * }, * { * type: "EMAIL", * groupEmail: "email@email.com", * sendEmailToAllUsers: true, * }, * { * type: "MSTEAMS", * microsoftTeamsWebhookUrl: "https://google.com", * }, * { * type: "PAGERDUTY", * pagerDutyKey: "pagerDutyKey", * }, * ], * linkedSsoDisplayName: "linked_sso_display_name", * ssoGroupId: "sso_group_id", * ssoGroupName: "sso_group_name", * linkedSsoType: "LDAP", * ssoLinked: true, * }); * // Create user group by adding user emails * const example = new harness.platform.Usergroup("example", { * identifier: "identifier", * name: "name", * orgId: "org_id", * projectId: "project_id", * linkedSsoId: "linked_sso_id", * externallyManaged: false, * userEmails: ["user@email.com"], * notificationConfigs: [ * { * type: "SLACK", * slackWebhookUrl: "https://google.com", * }, * { * type: "EMAIL", * groupEmail: "email@email.com", * sendEmailToAllUsers: true, * }, * { * type: "MSTEAMS", * microsoftTeamsWebhookUrl: "https://google.com", * }, * { * type: "PAGERDUTY", * pagerDutyKey: "pagerDutyKey", * }, * ], * linkedSsoDisplayName: "linked_sso_display_name", * ssoGroupId: "sso_group_name", * ssoGroupName: "sso_group_name", * linkedSsoType: "SAML", * ssoLinked: true, * }); * ``` * * ## Import * * The `pulumi import` command can be used, for example: * * Import account level user group * * ```sh * $ pulumi import harness:platform/usergroup:Usergroup example * ``` * * Import org level user group * * ```sh * $ pulumi import harness:platform/usergroup:Usergroup example / * ``` * * Import project level user group * * ```sh * $ pulumi import harness:platform/usergroup:Usergroup example // * ``` */ export declare class Usergroup extends pulumi.CustomResource { /** * Get an existing Usergroup 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, state?: UsergroupState, opts?: pulumi.CustomResourceOptions): Usergroup; /** * Returns true if the given object is an instance of Usergroup. 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 Usergroup; /** * Description of the resource. */ readonly description: pulumi.Output; /** * Whether the user group is externally managed. */ readonly externallyManaged: pulumi.Output; /** * Unique identifier of the resource. */ readonly identifier: pulumi.Output; /** * Name of the linked SSO. */ readonly linkedSsoDisplayName: pulumi.Output; /** * The SSO account ID that the user group is linked to. */ readonly linkedSsoId: pulumi.Output; /** * Type of linked SSO. */ readonly linkedSsoType: pulumi.Output; /** * Name of the resource. */ readonly name: pulumi.Output; /** * List of notification settings. */ readonly notificationConfigs: pulumi.Output; /** * Unique identifier of the organization. */ readonly orgId: pulumi.Output; /** * Unique identifier of the project. */ readonly projectId: pulumi.Output; /** * Identifier of the userGroup in SSO. */ readonly ssoGroupId: pulumi.Output; /** * Name of the SSO userGroup. */ readonly ssoGroupName: pulumi.Output; /** * Whether sso is linked or not. */ readonly ssoLinked: pulumi.Output; /** * Tags to associate with the resource. */ readonly tags: pulumi.Output; /** * List of user emails in the UserGroup. Either provide list of users or list of user emails. */ readonly userEmails: pulumi.Output; /** * List of users in the UserGroup. Either provide list of users or list of user emails. (Should be null for SSO managed) */ readonly users: pulumi.Output; /** * Create a Usergroup 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: UsergroupArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Usergroup resources. */ export interface UsergroupState { /** * Description of the resource. */ description?: pulumi.Input; /** * Whether the user group is externally managed. */ externallyManaged?: pulumi.Input; /** * Unique identifier of the resource. */ identifier?: pulumi.Input; /** * Name of the linked SSO. */ linkedSsoDisplayName?: pulumi.Input; /** * The SSO account ID that the user group is linked to. */ linkedSsoId?: pulumi.Input; /** * Type of linked SSO. */ linkedSsoType?: pulumi.Input; /** * Name of the resource. */ name?: pulumi.Input; /** * List of notification settings. */ notificationConfigs?: pulumi.Input[] | undefined>; /** * Unique identifier of the organization. */ orgId?: pulumi.Input; /** * Unique identifier of the project. */ projectId?: pulumi.Input; /** * Identifier of the userGroup in SSO. */ ssoGroupId?: pulumi.Input; /** * Name of the SSO userGroup. */ ssoGroupName?: pulumi.Input; /** * Whether sso is linked or not. */ ssoLinked?: pulumi.Input; /** * Tags to associate with the resource. */ tags?: pulumi.Input[] | undefined>; /** * List of user emails in the UserGroup. Either provide list of users or list of user emails. */ userEmails?: pulumi.Input[] | undefined>; /** * List of users in the UserGroup. Either provide list of users or list of user emails. (Should be null for SSO managed) */ users?: pulumi.Input[] | undefined>; } /** * The set of arguments for constructing a Usergroup resource. */ export interface UsergroupArgs { /** * Description of the resource. */ description?: pulumi.Input; /** * Whether the user group is externally managed. */ externallyManaged?: pulumi.Input; /** * Unique identifier of the resource. */ identifier: pulumi.Input; /** * Name of the linked SSO. */ linkedSsoDisplayName?: pulumi.Input; /** * The SSO account ID that the user group is linked to. */ linkedSsoId?: pulumi.Input; /** * Type of linked SSO. */ linkedSsoType?: pulumi.Input; /** * Name of the resource. */ name?: pulumi.Input; /** * List of notification settings. */ notificationConfigs?: pulumi.Input[] | undefined>; /** * Unique identifier of the organization. */ orgId?: pulumi.Input; /** * Unique identifier of the project. */ projectId?: pulumi.Input; /** * Identifier of the userGroup in SSO. */ ssoGroupId?: pulumi.Input; /** * Name of the SSO userGroup. */ ssoGroupName?: pulumi.Input; /** * Whether sso is linked or not. */ ssoLinked?: pulumi.Input; /** * Tags to associate with the resource. */ tags?: pulumi.Input[] | undefined>; /** * List of user emails in the UserGroup. Either provide list of users or list of user emails. */ userEmails?: pulumi.Input[] | undefined>; /** * List of users in the UserGroup. Either provide list of users or list of user emails. (Should be null for SSO managed) */ users?: pulumi.Input[] | undefined>; } //# sourceMappingURL=usergroup.d.ts.map