Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. User
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

filescom.User

filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

    A User represents a human or system/service user with the ability to connect to Files.com via any of the available connectivity methods (unless restricted to specific protocols).

    Users are associated with API Keys, SSH (SFTP) Keys, Notifications, Permissions, and Group memberships.

    Authentication

    The authenticationMethod property on a User determines exactly how that user can login and authenticate to their Files.com account. Files.com offers a variety of authentication methods to ensure flexibility, security, migration, and compliance.

    These authentication methods can be configured during user creation and can be modified at any time by site administrators. The meanings of the available values are as follows:

    • password - Allows authentication via a password. If API Keys or SSH (SFTP) Keys are also configured, those can be used instead of the password. If Two Factor Authentication (2FA) methods are also configured, a valid 2nd factor is required in addition to the password.

    • emailSignup - When set upon user creation, an email will be sent to the new user with a link for them to create their password. Once the user has created their password, their authentication type will change to password.

    • sso - Allows authentication via a linked Single Sign On provider. If API Keys or SSH (SFTP) Keys are also configured, those can be used instead of Single Sign On. If Two Factor Authentication (2FA) methods are also configured, a valid 2nd factor is required in addition to Single Sign On. When using this method, you must also provide a valid ssoStrategyId to associate the User to the appropriate SSO provider.

    • passwordWithImportedHash - Works like the password method but allows importing a hashed password in MD5, SHA-1, or SHA-256 format. Provide the imported hash in the field importedPasswordHash. Upon first use, the password will be converted to Files.com’s internal storage format and the authentication type will change to password. Typically only used when migrating to Files.com from another MFT solution.

    • none - Does not allow authentication via username and password, but does allow authentication via API Key or SSH (SFTP) Key. Typically only used for service users.

    • passwordAndSshKey - Allows authentication only by providing a password and also a valid SSH (SFTP) Key in a single attempt. If API Keys are also configured, those can be used instead of the password and key combination. This method only works with (typically enterprise) SSH/SFTP clients capable of sending both authentication methods at once. Typically only used for service users.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as filescom from "pulumi-filescom";

const exampleUser = new filescom.User("example_user", {
    avatarDelete: false,
    email: "john.doe@files.com",
    groupId: 1,
    groupIds: "example",
    announcementsRead: false,
    aiAssistantPersonalityId: 1,
    allowedIps: `10.0.0.0/8
127.0.0.1`,
    attachmentsPermission: true,
    authenticateUntil: "2000-01-01T01:00:00Z",
    authenticationMethod: "password",
    billingPermission: false,
    bypassUserLifecycleRules: false,
    bypassSiteAllowedIps: false,
    davPermission: true,
    desktopConfigurationProfileId: 1,
    defaultWorkspaceId: 1,
    disabled: true,
    filesystemLayout: "site_root",
    ftpPermission: true,
    headerText: "User-specific message.",
    integrationCentricProfileId: 1,
    language: "en",
    notificationDailySendTime: 18,
    name: "John Doe",
    company: "ACME Corp.",
    notes: "Internal notes on this user.",
    officeIntegrationEnabled: true,
    partnerAdmin: true,
    partnerId: 1,
    passwordValidityDays: 1,
    primaryGroupId: 1,
    readonlySiteAdmin: true,
    receiveAdminAlerts: true,
    notifyOnAllSiteWarnings: true,
    notifyOnAllSsoFailures: true,
    notifyOnAllUserSecurityEvents: true,
    notifyOnAllPendingWorkFailures: true,
    notifyOnAllSiemHttpDestinationFailures: true,
    notifyOnAllSyncFailures: true,
    notifyOnAllAutomationFailures: true,
    notifyOnAllExpectationFailures: true,
    requireLoginBy: "2000-01-01T01:00:00Z",
    requirePasswordChange: true,
    responsibleGroupId: 1,
    responsibleUserId: 1,
    restapiPermission: true,
    selfManaged: true,
    sftpPermission: true,
    siteAdmin: true,
    skipWelcomeScreen: true,
    sslRequired: "always_require",
    ssoStrategyId: 1,
    subscribeToNewsletter: true,
    require2fa: "always_require",
    tags: "example",
    timeZone: "Pacific Time (US & Canada)",
    userRoot: "example",
    userHome: "example",
    workspaceAdmin: true,
    username: "user",
    workspaceId: 1,
});

    import pulumi
import pulumi_filescom as filescom

example_user = filescom.User("example_user",
    avatar_delete=False,
    email="john.doe@files.com",
    group_id=1,
    group_ids="example",
    announcements_read=False,
    ai_assistant_personality_id=1,
    allowed_ips="""10.0.0.0/8
127.0.0.1""",
    attachments_permission=True,
    authenticate_until="2000-01-01T01:00:00Z",
    authentication_method="password",
    billing_permission=False,
    bypass_user_lifecycle_rules=False,
    bypass_site_allowed_ips=False,
    dav_permission=True,
    desktop_configuration_profile_id=1,
    default_workspace_id=1,
    disabled=True,
    filesystem_layout="site_root",
    ftp_permission=True,
    header_text="User-specific message.",
    integration_centric_profile_id=1,
    language="en",
    notification_daily_send_time=18,
    name="John Doe",
    company="ACME Corp.",
    notes="Internal notes on this user.",
    office_integration_enabled=True,
    partner_admin=True,
    partner_id=1,
    password_validity_days=1,
    primary_group_id=1,
    readonly_site_admin=True,
    receive_admin_alerts=True,
    notify_on_all_site_warnings=True,
    notify_on_all_sso_failures=True,
    notify_on_all_user_security_events=True,
    notify_on_all_pending_work_failures=True,
    notify_on_all_siem_http_destination_failures=True,
    notify_on_all_sync_failures=True,
    notify_on_all_automation_failures=True,
    notify_on_all_expectation_failures=True,
    require_login_by="2000-01-01T01:00:00Z",
    require_password_change=True,
    responsible_group_id=1,
    responsible_user_id=1,
    restapi_permission=True,
    self_managed=True,
    sftp_permission=True,
    site_admin=True,
    skip_welcome_screen=True,
    ssl_required="always_require",
    sso_strategy_id=1,
    subscribe_to_newsletter=True,
    require2fa="always_require",
    tags="example",
    time_zone="Pacific Time (US & Canada)",
    user_root="example",
    user_home="example",
    workspace_admin=True,
    username="user",
    workspace_id=1)

    package main

import (
	"github.com/jschady/pulumi-filescom/sdk/go/filescom"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := filescom.NewUser(ctx, "example_user", &filescom.UserArgs{
			AvatarDelete:                           pulumi.Bool(false),
			Email:                                  pulumi.String("john.doe@files.com"),
			GroupId:                                pulumi.Int(1),
			GroupIds:                               pulumi.String("example"),
			AnnouncementsRead:                      pulumi.Bool(false),
			AiAssistantPersonalityId:               pulumi.Int(1),
			AllowedIps:                             pulumi.String("10.0.0.0/8\n127.0.0.1"),
			AttachmentsPermission:                  pulumi.Bool(true),
			AuthenticateUntil:                      pulumi.String("2000-01-01T01:00:00Z"),
			AuthenticationMethod:                   pulumi.String("password"),
			BillingPermission:                      pulumi.Bool(false),
			BypassUserLifecycleRules:               pulumi.Bool(false),
			BypassSiteAllowedIps:                   pulumi.Bool(false),
			DavPermission:                          pulumi.Bool(true),
			DesktopConfigurationProfileId:          pulumi.Int(1),
			DefaultWorkspaceId:                     pulumi.Int(1),
			Disabled:                               pulumi.Bool(true),
			FilesystemLayout:                       pulumi.String("site_root"),
			FtpPermission:                          pulumi.Bool(true),
			HeaderText:                             pulumi.String("User-specific message."),
			IntegrationCentricProfileId:            pulumi.Int(1),
			Language:                               pulumi.String("en"),
			NotificationDailySendTime:              pulumi.Int(18),
			Name:                                   pulumi.String("John Doe"),
			Company:                                pulumi.String("ACME Corp."),
			Notes:                                  pulumi.String("Internal notes on this user."),
			OfficeIntegrationEnabled:               pulumi.Bool(true),
			PartnerAdmin:                           pulumi.Bool(true),
			PartnerId:                              pulumi.Int(1),
			PasswordValidityDays:                   pulumi.Int(1),
			PrimaryGroupId:                         pulumi.Int(1),
			ReadonlySiteAdmin:                      pulumi.Bool(true),
			ReceiveAdminAlerts:                     pulumi.Bool(true),
			NotifyOnAllSiteWarnings:                pulumi.Bool(true),
			NotifyOnAllSsoFailures:                 pulumi.Bool(true),
			NotifyOnAllUserSecurityEvents:          pulumi.Bool(true),
			NotifyOnAllPendingWorkFailures:         pulumi.Bool(true),
			NotifyOnAllSiemHttpDestinationFailures: pulumi.Bool(true),
			NotifyOnAllSyncFailures:                pulumi.Bool(true),
			NotifyOnAllAutomationFailures:          pulumi.Bool(true),
			NotifyOnAllExpectationFailures:         pulumi.Bool(true),
			RequireLoginBy:                         pulumi.String("2000-01-01T01:00:00Z"),
			RequirePasswordChange:                  pulumi.Bool(true),
			ResponsibleGroupId:                     pulumi.Int(1),
			ResponsibleUserId:                      pulumi.Int(1),
			RestapiPermission:                      pulumi.Bool(true),
			SelfManaged:                            pulumi.Bool(true),
			SftpPermission:                         pulumi.Bool(true),
			SiteAdmin:                              pulumi.Bool(true),
			SkipWelcomeScreen:                      pulumi.Bool(true),
			SslRequired:                            pulumi.String("always_require"),
			SsoStrategyId:                          pulumi.Int(1),
			SubscribeToNewsletter:                  pulumi.Bool(true),
			Require2fa:                             pulumi.String("always_require"),
			Tags:                                   pulumi.String("example"),
			TimeZone:                               pulumi.String("Pacific Time (US & Canada)"),
			UserRoot:                               pulumi.String("example"),
			UserHome:                               pulumi.String("example"),
			WorkspaceAdmin:                         pulumi.Bool(true),
			Username:                               pulumi.String("user"),
			WorkspaceId:                            pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Filescom = Jschady.Filescom;

return await Deployment.RunAsync(() => 
{
    var exampleUser = new Filescom.User("example_user", new()
    {
        AvatarDelete = false,
        Email = "john.doe@files.com",
        GroupId = 1,
        GroupIds = "example",
        AnnouncementsRead = false,
        AiAssistantPersonalityId = 1,
        AllowedIps = @"10.0.0.0/8
127.0.0.1",
        AttachmentsPermission = true,
        AuthenticateUntil = "2000-01-01T01:00:00Z",
        AuthenticationMethod = "password",
        BillingPermission = false,
        BypassUserLifecycleRules = false,
        BypassSiteAllowedIps = false,
        DavPermission = true,
        DesktopConfigurationProfileId = 1,
        DefaultWorkspaceId = 1,
        Disabled = true,
        FilesystemLayout = "site_root",
        FtpPermission = true,
        HeaderText = "User-specific message.",
        IntegrationCentricProfileId = 1,
        Language = "en",
        NotificationDailySendTime = 18,
        Name = "John Doe",
        Company = "ACME Corp.",
        Notes = "Internal notes on this user.",
        OfficeIntegrationEnabled = true,
        PartnerAdmin = true,
        PartnerId = 1,
        PasswordValidityDays = 1,
        PrimaryGroupId = 1,
        ReadonlySiteAdmin = true,
        ReceiveAdminAlerts = true,
        NotifyOnAllSiteWarnings = true,
        NotifyOnAllSsoFailures = true,
        NotifyOnAllUserSecurityEvents = true,
        NotifyOnAllPendingWorkFailures = true,
        NotifyOnAllSiemHttpDestinationFailures = true,
        NotifyOnAllSyncFailures = true,
        NotifyOnAllAutomationFailures = true,
        NotifyOnAllExpectationFailures = true,
        RequireLoginBy = "2000-01-01T01:00:00Z",
        RequirePasswordChange = true,
        ResponsibleGroupId = 1,
        ResponsibleUserId = 1,
        RestapiPermission = true,
        SelfManaged = true,
        SftpPermission = true,
        SiteAdmin = true,
        SkipWelcomeScreen = true,
        SslRequired = "always_require",
        SsoStrategyId = 1,
        SubscribeToNewsletter = true,
        Require2fa = "always_require",
        Tags = "example",
        TimeZone = "Pacific Time (US & Canada)",
        UserRoot = "example",
        UserHome = "example",
        WorkspaceAdmin = true,
        Username = "user",
        WorkspaceId = 1,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.User;
import com.pulumi.filescom.UserArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleUser = new User("exampleUser", UserArgs.builder()
            .avatarDelete(false)
            .email("john.doe@files.com")
            .groupId(1)
            .groupIds("example")
            .announcementsRead(false)
            .aiAssistantPersonalityId(1)
            .allowedIps("""
10.0.0.0/8
127.0.0.1            """)
            .attachmentsPermission(true)
            .authenticateUntil("2000-01-01T01:00:00Z")
            .authenticationMethod("password")
            .billingPermission(false)
            .bypassUserLifecycleRules(false)
            .bypassSiteAllowedIps(false)
            .davPermission(true)
            .desktopConfigurationProfileId(1)
            .defaultWorkspaceId(1)
            .disabled(true)
            .filesystemLayout("site_root")
            .ftpPermission(true)
            .headerText("User-specific message.")
            .integrationCentricProfileId(1)
            .language("en")
            .notificationDailySendTime(18)
            .name("John Doe")
            .company("ACME Corp.")
            .notes("Internal notes on this user.")
            .officeIntegrationEnabled(true)
            .partnerAdmin(true)
            .partnerId(1)
            .passwordValidityDays(1)
            .primaryGroupId(1)
            .readonlySiteAdmin(true)
            .receiveAdminAlerts(true)
            .notifyOnAllSiteWarnings(true)
            .notifyOnAllSsoFailures(true)
            .notifyOnAllUserSecurityEvents(true)
            .notifyOnAllPendingWorkFailures(true)
            .notifyOnAllSiemHttpDestinationFailures(true)
            .notifyOnAllSyncFailures(true)
            .notifyOnAllAutomationFailures(true)
            .notifyOnAllExpectationFailures(true)
            .requireLoginBy("2000-01-01T01:00:00Z")
            .requirePasswordChange(true)
            .responsibleGroupId(1)
            .responsibleUserId(1)
            .restapiPermission(true)
            .selfManaged(true)
            .sftpPermission(true)
            .siteAdmin(true)
            .skipWelcomeScreen(true)
            .sslRequired("always_require")
            .ssoStrategyId(1)
            .subscribeToNewsletter(true)
            .require2fa("always_require")
            .tags("example")
            .timeZone("Pacific Time (US & Canada)")
            .userRoot("example")
            .userHome("example")
            .workspaceAdmin(true)
            .username("user")
            .workspaceId(1)
            .build());

    }
}

    resources:
  exampleUser:
    type: filescom:User
    name: example_user
    properties:
      avatarDelete: false
      email: john.doe@files.com
      groupId: 1
      groupIds: example
      announcementsRead: false
      aiAssistantPersonalityId: 1
      allowedIps: |-
        10.0.0.0/8
        127.0.0.1
      attachmentsPermission: true
      authenticateUntil: 2000-01-01T01:00:00Z
      authenticationMethod: password
      billingPermission: false
      bypassUserLifecycleRules: false
      bypassSiteAllowedIps: false
      davPermission: true
      desktopConfigurationProfileId: 1
      defaultWorkspaceId: 1
      disabled: true
      filesystemLayout: site_root
      ftpPermission: true
      headerText: User-specific message.
      integrationCentricProfileId: 1
      language: en
      notificationDailySendTime: 18
      name: John Doe
      company: ACME Corp.
      notes: Internal notes on this user.
      officeIntegrationEnabled: true
      partnerAdmin: true
      partnerId: 1
      passwordValidityDays: 1
      primaryGroupId: 1
      readonlySiteAdmin: true
      receiveAdminAlerts: true
      notifyOnAllSiteWarnings: true
      notifyOnAllSsoFailures: true
      notifyOnAllUserSecurityEvents: true
      notifyOnAllPendingWorkFailures: true
      notifyOnAllSiemHttpDestinationFailures: true
      notifyOnAllSyncFailures: true
      notifyOnAllAutomationFailures: true
      notifyOnAllExpectationFailures: true
      requireLoginBy: 2000-01-01T01:00:00Z
      requirePasswordChange: true
      responsibleGroupId: 1
      responsibleUserId: 1
      restapiPermission: true
      selfManaged: true
      sftpPermission: true
      siteAdmin: true
      skipWelcomeScreen: true
      sslRequired: always_require
      ssoStrategyId: 1
      subscribeToNewsletter: true
      require2fa: always_require
      tags: example
      timeZone: Pacific Time (US & Canada)
      userRoot: example
      userHome: example
      workspaceAdmin: true
      username: user
      workspaceId: 1

    pulumi {
  required_providers {
    filescom = {
      source = "pulumi/filescom"
    }
  }
}

resource "filescom_user" "example_user" {
  avatar_delete                                = false
  email                                        = "john.doe@files.com"
  group_id                                     = 1
  group_ids                                    = "example"
  announcements_read                           = false
  ai_assistant_personality_id                  = 1
  allowed_ips                                  = "10.0.0.0/8\n127.0.0.1"
  attachments_permission                       = true
  authenticate_until                           = "2000-01-01T01:00:00Z"
  authentication_method                        = "password"
  billing_permission                           = false
  bypass_user_lifecycle_rules                  = false
  bypass_site_allowed_ips                      = false
  dav_permission                               = true
  desktop_configuration_profile_id             = 1
  default_workspace_id                         = 1
  disabled                                     = true
  filesystem_layout                            = "site_root"
  ftp_permission                               = true
  header_text                                  = "User-specific message."
  integration_centric_profile_id               = 1
  language                                     = "en"
  notification_daily_send_time                 = 18
  name                                         = "John Doe"
  company                                      = "ACME Corp."
  notes                                        = "Internal notes on this user."
  office_integration_enabled                   = true
  partner_admin                                = true
  partner_id                                   = 1
  password_validity_days                       = 1
  primary_group_id                             = 1
  readonly_site_admin                          = true
  receive_admin_alerts                         = true
  notify_on_all_site_warnings                  = true
  notify_on_all_sso_failures                   = true
  notify_on_all_user_security_events           = true
  notify_on_all_pending_work_failures          = true
  notify_on_all_siem_http_destination_failures = true
  notify_on_all_sync_failures                  = true
  notify_on_all_automation_failures            = true
  notify_on_all_expectation_failures           = true
  require_login_by                             = "2000-01-01T01:00:00Z"
  require_password_change                      = true
  responsible_group_id                         = 1
  responsible_user_id                          = 1
  restapi_permission                           = true
  self_managed                                 = true
  sftp_permission                              = true
  site_admin                                   = true
  skip_welcome_screen                          = true
  ssl_required                                 = "always_require"
  sso_strategy_id                              = 1
  subscribe_to_newsletter                      = true
  require2fa                                   = "always_require"
  tags                                         = "example"
  time_zone                                    = "Pacific Time (US & Canada)"
  user_root                                    = "example"
  user_home                                    = "example"
  workspace_admin                              = true
  username                                     = "user"
  workspace_id                                 = 1
}

    Create User Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
    @overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         username: Optional[str] = None,
         ai_assistant_personality_id: Optional[int] = None,
         allowed_ips: Optional[str] = None,
         announcements_read: Optional[bool] = None,
         attachments_permission: Optional[bool] = None,
         authenticate_until: Optional[str] = None,
         authentication_method: Optional[str] = None,
         avatar_delete: Optional[bool] = None,
         billing_permission: Optional[bool] = None,
         bypass_site_allowed_ips: Optional[bool] = None,
         bypass_user_lifecycle_rules: Optional[bool] = None,
         change_password: Optional[str] = None,
         change_password_confirmation: Optional[str] = None,
         company: Optional[str] = None,
         dav_permission: Optional[bool] = None,
         default_workspace_id: Optional[int] = None,
         desktop_configuration_profile_id: Optional[int] = None,
         disabled: Optional[bool] = None,
         email: Optional[str] = None,
         filesystem_layout: Optional[str] = None,
         ftp_permission: Optional[bool] = None,
         grant_permission: Optional[str] = None,
         group_id: Optional[int] = None,
         group_ids: Optional[str] = None,
         header_text: Optional[str] = None,
         imported_password_hash: Optional[str] = None,
         integration_centric_profile_id: Optional[int] = None,
         language: Optional[str] = None,
         name: Optional[str] = None,
         notes: Optional[str] = None,
         notification_daily_send_time: Optional[int] = None,
         notify_on_all_automation_failures: Optional[bool] = None,
         notify_on_all_expectation_failures: Optional[bool] = None,
         notify_on_all_pending_work_failures: Optional[bool] = None,
         notify_on_all_siem_http_destination_failures: Optional[bool] = None,
         notify_on_all_site_warnings: Optional[bool] = None,
         notify_on_all_sso_failures: Optional[bool] = None,
         notify_on_all_sync_failures: Optional[bool] = None,
         notify_on_all_user_security_events: Optional[bool] = None,
         office_integration_enabled: Optional[bool] = None,
         partner_admin: Optional[bool] = None,
         partner_id: Optional[int] = None,
         password: Optional[str] = None,
         password_confirmation: Optional[str] = None,
         password_validity_days: Optional[int] = None,
         primary_group_id: Optional[int] = None,
         readonly_site_admin: Optional[bool] = None,
         receive_admin_alerts: Optional[bool] = None,
         require2fa: Optional[str] = None,
         require_login_by: Optional[str] = None,
         require_password_change: Optional[bool] = None,
         responsible_group_id: Optional[int] = None,
         responsible_user_id: Optional[int] = None,
         restapi_permission: Optional[bool] = None,
         self_managed: Optional[bool] = None,
         sftp_permission: Optional[bool] = None,
         site_admin: Optional[bool] = None,
         skip_welcome_screen: Optional[bool] = None,
         ssl_required: Optional[str] = None,
         sso_strategy_id: Optional[int] = None,
         subscribe_to_newsletter: Optional[bool] = None,
         tags: Optional[str] = None,
         time_zone: Optional[str] = None,
         user_home: Optional[str] = None,
         user_root: Optional[str] = None,
         workspace_admin: Optional[bool] = None,
         workspace_id: Optional[int] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

    type: filescom:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "filescom_user" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var userResource = new Filescom.User("userResource", new()
{
    Username = "string",
    AiAssistantPersonalityId = 0,
    AllowedIps = "string",
    AnnouncementsRead = false,
    AttachmentsPermission = false,
    AuthenticateUntil = "string",
    AuthenticationMethod = "string",
    AvatarDelete = false,
    BillingPermission = false,
    BypassSiteAllowedIps = false,
    BypassUserLifecycleRules = false,
    ChangePassword = "string",
    ChangePasswordConfirmation = "string",
    Company = "string",
    DavPermission = false,
    DefaultWorkspaceId = 0,
    DesktopConfigurationProfileId = 0,
    Disabled = false,
    Email = "string",
    FilesystemLayout = "string",
    FtpPermission = false,
    GrantPermission = "string",
    GroupId = 0,
    GroupIds = "string",
    HeaderText = "string",
    ImportedPasswordHash = "string",
    IntegrationCentricProfileId = 0,
    Language = "string",
    Name = "string",
    Notes = "string",
    NotificationDailySendTime = 0,
    NotifyOnAllAutomationFailures = false,
    NotifyOnAllExpectationFailures = false,
    NotifyOnAllPendingWorkFailures = false,
    NotifyOnAllSiemHttpDestinationFailures = false,
    NotifyOnAllSiteWarnings = false,
    NotifyOnAllSsoFailures = false,
    NotifyOnAllSyncFailures = false,
    NotifyOnAllUserSecurityEvents = false,
    OfficeIntegrationEnabled = false,
    PartnerAdmin = false,
    PartnerId = 0,
    Password = "string",
    PasswordConfirmation = "string",
    PasswordValidityDays = 0,
    PrimaryGroupId = 0,
    ReadonlySiteAdmin = false,
    ReceiveAdminAlerts = false,
    Require2fa = "string",
    RequireLoginBy = "string",
    RequirePasswordChange = false,
    ResponsibleGroupId = 0,
    ResponsibleUserId = 0,
    RestapiPermission = false,
    SelfManaged = false,
    SftpPermission = false,
    SiteAdmin = false,
    SkipWelcomeScreen = false,
    SslRequired = "string",
    SsoStrategyId = 0,
    SubscribeToNewsletter = false,
    Tags = "string",
    TimeZone = "string",
    UserHome = "string",
    UserRoot = "string",
    WorkspaceAdmin = false,
    WorkspaceId = 0,
});

    example, err := filescom.NewUser(ctx, "userResource", &filescom.UserArgs{
	Username:                               pulumi.String("string"),
	AiAssistantPersonalityId:               pulumi.Int(0),
	AllowedIps:                             pulumi.String("string"),
	AnnouncementsRead:                      pulumi.Bool(false),
	AttachmentsPermission:                  pulumi.Bool(false),
	AuthenticateUntil:                      pulumi.String("string"),
	AuthenticationMethod:                   pulumi.String("string"),
	AvatarDelete:                           pulumi.Bool(false),
	BillingPermission:                      pulumi.Bool(false),
	BypassSiteAllowedIps:                   pulumi.Bool(false),
	BypassUserLifecycleRules:               pulumi.Bool(false),
	ChangePassword:                         pulumi.String("string"),
	ChangePasswordConfirmation:             pulumi.String("string"),
	Company:                                pulumi.String("string"),
	DavPermission:                          pulumi.Bool(false),
	DefaultWorkspaceId:                     pulumi.Int(0),
	DesktopConfigurationProfileId:          pulumi.Int(0),
	Disabled:                               pulumi.Bool(false),
	Email:                                  pulumi.String("string"),
	FilesystemLayout:                       pulumi.String("string"),
	FtpPermission:                          pulumi.Bool(false),
	GrantPermission:                        pulumi.String("string"),
	GroupId:                                pulumi.Int(0),
	GroupIds:                               pulumi.String("string"),
	HeaderText:                             pulumi.String("string"),
	ImportedPasswordHash:                   pulumi.String("string"),
	IntegrationCentricProfileId:            pulumi.Int(0),
	Language:                               pulumi.String("string"),
	Name:                                   pulumi.String("string"),
	Notes:                                  pulumi.String("string"),
	NotificationDailySendTime:              pulumi.Int(0),
	NotifyOnAllAutomationFailures:          pulumi.Bool(false),
	NotifyOnAllExpectationFailures:         pulumi.Bool(false),
	NotifyOnAllPendingWorkFailures:         pulumi.Bool(false),
	NotifyOnAllSiemHttpDestinationFailures: pulumi.Bool(false),
	NotifyOnAllSiteWarnings:                pulumi.Bool(false),
	NotifyOnAllSsoFailures:                 pulumi.Bool(false),
	NotifyOnAllSyncFailures:                pulumi.Bool(false),
	NotifyOnAllUserSecurityEvents:          pulumi.Bool(false),
	OfficeIntegrationEnabled:               pulumi.Bool(false),
	PartnerAdmin:                           pulumi.Bool(false),
	PartnerId:                              pulumi.Int(0),
	Password:                               pulumi.String("string"),
	PasswordConfirmation:                   pulumi.String("string"),
	PasswordValidityDays:                   pulumi.Int(0),
	PrimaryGroupId:                         pulumi.Int(0),
	ReadonlySiteAdmin:                      pulumi.Bool(false),
	ReceiveAdminAlerts:                     pulumi.Bool(false),
	Require2fa:                             pulumi.String("string"),
	RequireLoginBy:                         pulumi.String("string"),
	RequirePasswordChange:                  pulumi.Bool(false),
	ResponsibleGroupId:                     pulumi.Int(0),
	ResponsibleUserId:                      pulumi.Int(0),
	RestapiPermission:                      pulumi.Bool(false),
	SelfManaged:                            pulumi.Bool(false),
	SftpPermission:                         pulumi.Bool(false),
	SiteAdmin:                              pulumi.Bool(false),
	SkipWelcomeScreen:                      pulumi.Bool(false),
	SslRequired:                            pulumi.String("string"),
	SsoStrategyId:                          pulumi.Int(0),
	SubscribeToNewsletter:                  pulumi.Bool(false),
	Tags:                                   pulumi.String("string"),
	TimeZone:                               pulumi.String("string"),
	UserHome:                               pulumi.String("string"),
	UserRoot:                               pulumi.String("string"),
	WorkspaceAdmin:                         pulumi.Bool(false),
	WorkspaceId:                            pulumi.Int(0),
})

    resource "filescom_user" "userResource" {
  lifecycle {
    create_before_destroy = true
  }
  username                                     = "string"
  ai_assistant_personality_id                  = 0
  allowed_ips                                  = "string"
  announcements_read                           = false
  attachments_permission                       = false
  authenticate_until                           = "string"
  authentication_method                        = "string"
  avatar_delete                                = false
  billing_permission                           = false
  bypass_site_allowed_ips                      = false
  bypass_user_lifecycle_rules                  = false
  change_password                              = "string"
  change_password_confirmation                 = "string"
  company                                      = "string"
  dav_permission                               = false
  default_workspace_id                         = 0
  desktop_configuration_profile_id             = 0
  disabled                                     = false
  email                                        = "string"
  filesystem_layout                            = "string"
  ftp_permission                               = false
  grant_permission                             = "string"
  group_id                                     = 0
  group_ids                                    = "string"
  header_text                                  = "string"
  imported_password_hash                       = "string"
  integration_centric_profile_id               = 0
  language                                     = "string"
  name                                         = "string"
  notes                                        = "string"
  notification_daily_send_time                 = 0
  notify_on_all_automation_failures            = false
  notify_on_all_expectation_failures           = false
  notify_on_all_pending_work_failures          = false
  notify_on_all_siem_http_destination_failures = false
  notify_on_all_site_warnings                  = false
  notify_on_all_sso_failures                   = false
  notify_on_all_sync_failures                  = false
  notify_on_all_user_security_events           = false
  office_integration_enabled                   = false
  partner_admin                                = false
  partner_id                                   = 0
  password                                     = "string"
  password_confirmation                        = "string"
  password_validity_days                       = 0
  primary_group_id                             = 0
  readonly_site_admin                          = false
  receive_admin_alerts                         = false
  require2fa                                   = "string"
  require_login_by                             = "string"
  require_password_change                      = false
  responsible_group_id                         = 0
  responsible_user_id                          = 0
  restapi_permission                           = false
  self_managed                                 = false
  sftp_permission                              = false
  site_admin                                   = false
  skip_welcome_screen                          = false
  ssl_required                                 = "string"
  sso_strategy_id                              = 0
  subscribe_to_newsletter                      = false
  tags                                         = "string"
  time_zone                                    = "string"
  user_home                                    = "string"
  user_root                                    = "string"
  workspace_admin                              = false
  workspace_id                                 = 0
}

    var userResource = new User("userResource", UserArgs.builder()
    .username("string")
    .aiAssistantPersonalityId(0)
    .allowedIps("string")
    .announcementsRead(false)
    .attachmentsPermission(false)
    .authenticateUntil("string")
    .authenticationMethod("string")
    .avatarDelete(false)
    .billingPermission(false)
    .bypassSiteAllowedIps(false)
    .bypassUserLifecycleRules(false)
    .changePassword("string")
    .changePasswordConfirmation("string")
    .company("string")
    .davPermission(false)
    .defaultWorkspaceId(0)
    .desktopConfigurationProfileId(0)
    .disabled(false)
    .email("string")
    .filesystemLayout("string")
    .ftpPermission(false)
    .grantPermission("string")
    .groupId(0)
    .groupIds("string")
    .headerText("string")
    .importedPasswordHash("string")
    .integrationCentricProfileId(0)
    .language("string")
    .name("string")
    .notes("string")
    .notificationDailySendTime(0)
    .notifyOnAllAutomationFailures(false)
    .notifyOnAllExpectationFailures(false)
    .notifyOnAllPendingWorkFailures(false)
    .notifyOnAllSiemHttpDestinationFailures(false)
    .notifyOnAllSiteWarnings(false)
    .notifyOnAllSsoFailures(false)
    .notifyOnAllSyncFailures(false)
    .notifyOnAllUserSecurityEvents(false)
    .officeIntegrationEnabled(false)
    .partnerAdmin(false)
    .partnerId(0)
    .password("string")
    .passwordConfirmation("string")
    .passwordValidityDays(0)
    .primaryGroupId(0)
    .readonlySiteAdmin(false)
    .receiveAdminAlerts(false)
    .require2fa("string")
    .requireLoginBy("string")
    .requirePasswordChange(false)
    .responsibleGroupId(0)
    .responsibleUserId(0)
    .restapiPermission(false)
    .selfManaged(false)
    .sftpPermission(false)
    .siteAdmin(false)
    .skipWelcomeScreen(false)
    .sslRequired("string")
    .ssoStrategyId(0)
    .subscribeToNewsletter(false)
    .tags("string")
    .timeZone("string")
    .userHome("string")
    .userRoot("string")
    .workspaceAdmin(false)
    .workspaceId(0)
    .build());

    user_resource = filescom.User("userResource",
    username="string",
    ai_assistant_personality_id=0,
    allowed_ips="string",
    announcements_read=False,
    attachments_permission=False,
    authenticate_until="string",
    authentication_method="string",
    avatar_delete=False,
    billing_permission=False,
    bypass_site_allowed_ips=False,
    bypass_user_lifecycle_rules=False,
    change_password="string",
    change_password_confirmation="string",
    company="string",
    dav_permission=False,
    default_workspace_id=0,
    desktop_configuration_profile_id=0,
    disabled=False,
    email="string",
    filesystem_layout="string",
    ftp_permission=False,
    grant_permission="string",
    group_id=0,
    group_ids="string",
    header_text="string",
    imported_password_hash="string",
    integration_centric_profile_id=0,
    language="string",
    name="string",
    notes="string",
    notification_daily_send_time=0,
    notify_on_all_automation_failures=False,
    notify_on_all_expectation_failures=False,
    notify_on_all_pending_work_failures=False,
    notify_on_all_siem_http_destination_failures=False,
    notify_on_all_site_warnings=False,
    notify_on_all_sso_failures=False,
    notify_on_all_sync_failures=False,
    notify_on_all_user_security_events=False,
    office_integration_enabled=False,
    partner_admin=False,
    partner_id=0,
    password="string",
    password_confirmation="string",
    password_validity_days=0,
    primary_group_id=0,
    readonly_site_admin=False,
    receive_admin_alerts=False,
    require2fa="string",
    require_login_by="string",
    require_password_change=False,
    responsible_group_id=0,
    responsible_user_id=0,
    restapi_permission=False,
    self_managed=False,
    sftp_permission=False,
    site_admin=False,
    skip_welcome_screen=False,
    ssl_required="string",
    sso_strategy_id=0,
    subscribe_to_newsletter=False,
    tags="string",
    time_zone="string",
    user_home="string",
    user_root="string",
    workspace_admin=False,
    workspace_id=0)

    const userResource = new filescom.User("userResource", {
    username: "string",
    aiAssistantPersonalityId: 0,
    allowedIps: "string",
    announcementsRead: false,
    attachmentsPermission: false,
    authenticateUntil: "string",
    authenticationMethod: "string",
    avatarDelete: false,
    billingPermission: false,
    bypassSiteAllowedIps: false,
    bypassUserLifecycleRules: false,
    changePassword: "string",
    changePasswordConfirmation: "string",
    company: "string",
    davPermission: false,
    defaultWorkspaceId: 0,
    desktopConfigurationProfileId: 0,
    disabled: false,
    email: "string",
    filesystemLayout: "string",
    ftpPermission: false,
    grantPermission: "string",
    groupId: 0,
    groupIds: "string",
    headerText: "string",
    importedPasswordHash: "string",
    integrationCentricProfileId: 0,
    language: "string",
    name: "string",
    notes: "string",
    notificationDailySendTime: 0,
    notifyOnAllAutomationFailures: false,
    notifyOnAllExpectationFailures: false,
    notifyOnAllPendingWorkFailures: false,
    notifyOnAllSiemHttpDestinationFailures: false,
    notifyOnAllSiteWarnings: false,
    notifyOnAllSsoFailures: false,
    notifyOnAllSyncFailures: false,
    notifyOnAllUserSecurityEvents: false,
    officeIntegrationEnabled: false,
    partnerAdmin: false,
    partnerId: 0,
    password: "string",
    passwordConfirmation: "string",
    passwordValidityDays: 0,
    primaryGroupId: 0,
    readonlySiteAdmin: false,
    receiveAdminAlerts: false,
    require2fa: "string",
    requireLoginBy: "string",
    requirePasswordChange: false,
    responsibleGroupId: 0,
    responsibleUserId: 0,
    restapiPermission: false,
    selfManaged: false,
    sftpPermission: false,
    siteAdmin: false,
    skipWelcomeScreen: false,
    sslRequired: "string",
    ssoStrategyId: 0,
    subscribeToNewsletter: false,
    tags: "string",
    timeZone: "string",
    userHome: "string",
    userRoot: "string",
    workspaceAdmin: false,
    workspaceId: 0,
});

    type: filescom:User
properties:
    aiAssistantPersonalityId: 0
    allowedIps: string
    announcementsRead: false
    attachmentsPermission: false
    authenticateUntil: string
    authenticationMethod: string
    avatarDelete: false
    billingPermission: false
    bypassSiteAllowedIps: false
    bypassUserLifecycleRules: false
    changePassword: string
    changePasswordConfirmation: string
    company: string
    davPermission: false
    defaultWorkspaceId: 0
    desktopConfigurationProfileId: 0
    disabled: false
    email: string
    filesystemLayout: string
    ftpPermission: false
    grantPermission: string
    groupId: 0
    groupIds: string
    headerText: string
    importedPasswordHash: string
    integrationCentricProfileId: 0
    language: string
    name: string
    notes: string
    notificationDailySendTime: 0
    notifyOnAllAutomationFailures: false
    notifyOnAllExpectationFailures: false
    notifyOnAllPendingWorkFailures: false
    notifyOnAllSiemHttpDestinationFailures: false
    notifyOnAllSiteWarnings: false
    notifyOnAllSsoFailures: false
    notifyOnAllSyncFailures: false
    notifyOnAllUserSecurityEvents: false
    officeIntegrationEnabled: false
    partnerAdmin: false
    partnerId: 0
    password: string
    passwordConfirmation: string
    passwordValidityDays: 0
    primaryGroupId: 0
    readonlySiteAdmin: false
    receiveAdminAlerts: false
    require2fa: string
    requireLoginBy: string
    requirePasswordChange: false
    responsibleGroupId: 0
    responsibleUserId: 0
    restapiPermission: false
    selfManaged: false
    sftpPermission: false
    siteAdmin: false
    skipWelcomeScreen: false
    sslRequired: string
    ssoStrategyId: 0
    subscribeToNewsletter: false
    tags: string
    timeZone: string
    userHome: string
    userRoot: string
    username: string
    workspaceAdmin: false
    workspaceId: 0

    User Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The User resource accepts the following input properties:

    Username string
    User's username
    AiAssistantPersonalityId int
    AI Assistant Personality ID assigned directly to this user, if any.
    AllowedIps string
    A list of allowed IPs if applicable. Newline delimited
    AnnouncementsRead bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Signifies that the user has read all the announcements in the UI.
    AttachmentsPermission bool
    If true, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
    AuthenticateUntil string
    Scheduled Date/Time at which user will be deactivated
    AuthenticationMethod string
    How is this user authenticated?
    AvatarDelete bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, the avatar will be deleted.
    BillingPermission bool
    Allow this user to perform operations on the account, payments, and invoices?
    BypassSiteAllowedIps bool
    Allow this user to skip site-wide IP blacklists?
    BypassUserLifecycleRules bool
    Exempt this user from user lifecycle rules?
    ChangePassword string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Used for changing a password on an existing user.
    ChangePasswordConfirmation string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in changePassword.
    Company string
    User's company
    DavPermission bool
    Can the user connect with WebDAV?
    DefaultWorkspaceId int
    Workspace ID the user should land in by default when more than one Workspace is available.
    DesktopConfigurationProfileId int
    Desktop Configuration Profile ID assigned directly to this user, if any.
    Disabled bool
    Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
    Email string
    User email address
    FilesystemLayout string
    File system layout
    FtpPermission bool
    Can the user access with FTP/FTPS?
    GrantPermission string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Permission to grant on the User Root upon user creation. Can be blank or full, read, write, list, read+write, or list+write
    GroupId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Group ID to associate this user with.
    GroupIds string
    Comma-separated list of group IDs of which this user is a member
    HeaderText string
    Text to display to the user in the header of the UI
    ImportedPasswordHash string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
    IntegrationCentricProfileId int
    Integration Centric Profile ID assigned directly to this user, if any.
    Language string
    Preferred language
    Name string
    User's full name
    Notes string
    Any internal notes on the user
    NotificationDailySendTime int
    Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
    NotifyOnAllAutomationFailures bool
    Should the user receive automation failures via email?
    NotifyOnAllExpectationFailures bool
    Should the user receive expectation failures and misses via email?
    NotifyOnAllPendingWorkFailures bool
    Should the user receive pending work failures via email?
    NotifyOnAllSiemHttpDestinationFailures bool
    Should the user receive siem failures via email?
    NotifyOnAllSiteWarnings bool
    Should the user receive site warnings via email?
    NotifyOnAllSsoFailures bool
    Should the user receive sso/scim/ldap configuration/sync failures via email?
    NotifyOnAllSyncFailures bool
    Should the user receive sync failures via email?
    NotifyOnAllUserSecurityEvents bool
    Should the user receive user security events via email?
    OfficeIntegrationEnabled bool
    Enable integration with Office for the web?
    PartnerAdmin bool
    Is this user a Partner administrator?
    PartnerId int
    Partner ID if this user belongs to a Partner
    Password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User password.
    PasswordConfirmation string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in password.
    PasswordValidityDays int
    Number of days to allow user to use the same password
    PrimaryGroupId int
    Primary group ID for Group Admin scoping
    ReadonlySiteAdmin bool
    Is the user an allowed to view all (non-billing) site configuration for this site?
    ReceiveAdminAlerts bool
    Deprecated. Use notifyOnAllSiteWarnings and granular failure notification preferences instead.
    Require2fa string
    2FA required setting. useSystemSetting uses the site-wide setting, including SSO exemptions. alwaysRequire and neverRequire override the site-wide setting when user-level overrides are allowed.
    RequireLoginBy string
    Require user to login by specified date otherwise it will be disabled.
    RequirePasswordChange bool
    Is a password change required upon next user login?
    ResponsibleGroupId int
    ID of the internal Group responsible for this Partner User, overriding the Partner default.
    ResponsibleUserId int
    ID of the internal User responsible for this Partner User, overriding the Partner default.
    RestapiPermission bool
    Can this user access the Web app, Desktop app, SDKs, or REST API? (All of these tools use the API internally, so this is one unified permission set.)
    SelfManaged bool
    Does this user manage it's own credentials or is it a shared/bot user?
    SftpPermission bool
    Can the user access with SFTP?
    SiteAdmin bool
    Is the user an administrator for this site?
    SkipWelcomeScreen bool
    Skip Welcome page in the UI?
    SslRequired string
    SSL required setting
    SsoStrategyId int
    SSO (Single Sign On) strategy ID for the user, if applicable.
    SubscribeToNewsletter bool
    Is the user subscribed to the newsletter?
    Tags string
    Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    TimeZone string
    User time zone
    UserHome string
    Home folder for FTP/SFTP. For users with the partnerRoot filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
    UserRoot string
    If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteRoot or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partnerRoot layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
    WorkspaceAdmin bool
    Is the user a Workspace administrator? Applicable only to the workspace ID related to this user, if one is set.
    WorkspaceId int
    Workspace ID
    Username string
    User's username
    AiAssistantPersonalityId int
    AI Assistant Personality ID assigned directly to this user, if any.
    AllowedIps string
    A list of allowed IPs if applicable. Newline delimited
    AnnouncementsRead bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Signifies that the user has read all the announcements in the UI.
    AttachmentsPermission bool
    If true, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
    AuthenticateUntil string
    Scheduled Date/Time at which user will be deactivated
    AuthenticationMethod string
    How is this user authenticated?
    AvatarDelete bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, the avatar will be deleted.
    BillingPermission bool
    Allow this user to perform operations on the account, payments, and invoices?
    BypassSiteAllowedIps bool
    Allow this user to skip site-wide IP blacklists?
    BypassUserLifecycleRules bool
    Exempt this user from user lifecycle rules?
    ChangePassword string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Used for changing a password on an existing user.
    ChangePasswordConfirmation string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in changePassword.
    Company string
    User's company
    DavPermission bool
    Can the user connect with WebDAV?
    DefaultWorkspaceId int
    Workspace ID the user should land in by default when more than one Workspace is available.
    DesktopConfigurationProfileId int
    Desktop Configuration Profile ID assigned directly to this user, if any.
    Disabled bool
    Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
    Email string
    User email address
    FilesystemLayout string
    File system layout
    FtpPermission bool
    Can the user access with FTP/FTPS?
    GrantPermission string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Permission to grant on the User Root upon user creation. Can be blank or full, read, write, list, read+write, or list+write
    GroupId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Group ID to associate this user with.
    GroupIds string
    Comma-separated list of group IDs of which this user is a member
    HeaderText string
    Text to display to the user in the header of the UI
    ImportedPasswordHash string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
    IntegrationCentricProfileId int
    Integration Centric Profile ID assigned directly to this user, if any.
    Language string
    Preferred language
    Name string
    User's full name
    Notes string
    Any internal notes on the user
    NotificationDailySendTime int
    Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
    NotifyOnAllAutomationFailures bool
    Should the user receive automation failures via email?
    NotifyOnAllExpectationFailures bool
    Should the user receive expectation failures and misses via email?
    NotifyOnAllPendingWorkFailures bool
    Should the user receive pending work failures via email?
    NotifyOnAllSiemHttpDestinationFailures bool
    Should the user receive siem failures via email?
    NotifyOnAllSiteWarnings bool
    Should the user receive site warnings via email?
    NotifyOnAllSsoFailures bool
    Should the user receive sso/scim/ldap configuration/sync failures via email?
    NotifyOnAllSyncFailures bool
    Should the user receive sync failures via email?
    NotifyOnAllUserSecurityEvents bool
    Should the user receive user security events via email?
    OfficeIntegrationEnabled bool
    Enable integration with Office for the web?
    PartnerAdmin bool
    Is this user a Partner administrator?
    PartnerId int
    Partner ID if this user belongs to a Partner
    Password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User password.
    PasswordConfirmation string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in password.
    PasswordValidityDays int
    Number of days to allow user to use the same password
    PrimaryGroupId int
    Primary group ID for Group Admin scoping
    ReadonlySiteAdmin bool
    Is the user an allowed to view all (non-billing) site configuration for this site?
    ReceiveAdminAlerts bool
    Deprecated. Use notifyOnAllSiteWarnings and granular failure notification preferences instead.
    Require2fa string
    2FA required setting. useSystemSetting uses the site-wide setting, including SSO exemptions. alwaysRequire and neverRequire override the site-wide setting when user-level overrides are allowed.
    RequireLoginBy string
    Require user to login by specified date otherwise it will be disabled.
    RequirePasswordChange bool
    Is a password change required upon next user login?
    ResponsibleGroupId int
    ID of the internal Group responsible for this Partner User, overriding the Partner default.
    ResponsibleUserId int
    ID of the internal User responsible for this Partner User, overriding the Partner default.
    RestapiPermission bool
    Can this user access the Web app, Desktop app, SDKs, or REST API? (All of these tools use the API internally, so this is one unified permission set.)
    SelfManaged bool
    Does this user manage it's own credentials or is it a shared/bot user?
    SftpPermission bool
    Can the user access with SFTP?
    SiteAdmin bool
    Is the user an administrator for this site?
    SkipWelcomeScreen bool
    Skip Welcome page in the UI?
    SslRequired string
    SSL required setting
    SsoStrategyId int
    SSO (Single Sign On) strategy ID for the user, if applicable.
    SubscribeToNewsletter bool
    Is the user subscribed to the newsletter?
    Tags string
    Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    TimeZone string
    User time zone
    UserHome string
    Home folder for FTP/SFTP. For users with the partnerRoot filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
    UserRoot string
    If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteRoot or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partnerRoot layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
    WorkspaceAdmin bool
    Is the user a Workspace administrator? Applicable only to the workspace ID related to this user, if one is set.
    WorkspaceId int
    Workspace ID
    username string
    User's username
    ai_assistant_personality_id number
    AI Assistant Personality ID assigned directly to this user, if any.
    allowed_ips string
    A list of allowed IPs if applicable. Newline delimited
    announcements_read bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Signifies that the user has read all the announcements in the UI.
    attachments_permission bool
    If true, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
    authenticate_until string
    Scheduled Date/Time at which user will be deactivated
    authentication_method string
    How is this user authenticated?
    avatar_delete bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, the avatar will be deleted.
    billing_permission bool
    Allow this user to perform operations on the account, payments, and invoices?
    bypass_site_allowed_ips bool
    Allow this user to skip site-wide IP blacklists?
    bypass_user_lifecycle_rules bool
    Exempt this user from user lifecycle rules?
    change_password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Used for changing a password on an existing user.
    change_password_confirmation string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in changePassword.
    company string
    User's company
    dav_permission bool
    Can the user connect with WebDAV?
    default_workspace_id number
    Workspace ID the user should land in by default when more than one Workspace is available.
    desktop_configuration_profile_id number
    Desktop Configuration Profile ID assigned directly to this user, if any.
    disabled bool
    Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
    email string
    User email address
    filesystem_layout string
    File system layout
    ftp_permission bool
    Can the user access with FTP/FTPS?
    grant_permission string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Permission to grant on the User Root upon user creation. Can be blank or full, read, write, list, read+write, or list+write
    group_id number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Group ID to associate this user with.
    group_ids string
    Comma-separated list of group IDs of which this user is a member
    header_text string
    Text to display to the user in the header of the UI
    imported_password_hash string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
    integration_centric_profile_id number
    Integration Centric Profile ID assigned directly to this user, if any.
    language string
    Preferred language
    name string
    User's full name
    notes string
    Any internal notes on the user
    notification_daily_send_time number
    Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
    notify_on_all_automation_failures bool
    Should the user receive automation failures via email?
    notify_on_all_expectation_failures bool
    Should the user receive expectation failures and misses via email?
    notify_on_all_pending_work_failures bool
    Should the user receive pending work failures via email?
    notify_on_all_siem_http_destination_failures bool
    Should the user receive siem failures via email?
    notify_on_all_site_warnings bool
    Should the user receive site warnings via email?
    notify_on_all_sso_failures bool
    Should the user receive sso/scim/ldap configuration/sync failures via email?
    notify_on_all_sync_failures bool
    Should the user receive sync failures via email?
    notify_on_all_user_security_events bool
    Should the user receive user security events via email?
    office_integration_enabled bool
    Enable integration with Office for the web?
    partner_admin bool
    Is this user a Partner administrator?
    partner_id number
    Partner ID if this user belongs to a Partner
    password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User password.
    password_confirmation string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in password.
    password_validity_days number
    Number of days to allow user to use the same password
    primary_group_id number
    Primary group ID for Group Admin scoping
    readonly_site_admin bool
    Is the user an allowed to view all (non-billing) site configuration for this site?
    receive_admin_alerts bool
    Deprecated. Use notifyOnAllSiteWarnings and granular failure notification preferences instead.
    require2fa string
    2FA required setting. useSystemSetting uses the site-wide setting, including SSO exemptions. alwaysRequire and neverRequire override the site-wide setting when user-level overrides are allowed.
    require_login_by string
    Require user to login by specified date otherwise it will be disabled.
    require_password_change bool
    Is a password change required upon next user login?
    responsible_group_id number
    ID of the internal Group responsible for this Partner User, overriding the Partner default.
    responsible_user_id number
    ID of the internal User responsible for this Partner User, overriding the Partner default.
    restapi_permission bool
    Can this user access the Web app, Desktop app, SDKs, or REST API? (All of these tools use the API internally, so this is one unified permission set.)
    self_managed bool
    Does this user manage it's own credentials or is it a shared/bot user?
    sftp_permission bool
    Can the user access with SFTP?
    site_admin bool
    Is the user an administrator for this site?
    skip_welcome_screen bool
    Skip Welcome page in the UI?
    ssl_required string
    SSL required setting
    sso_strategy_id number
    SSO (Single Sign On) strategy ID for the user, if applicable.
    subscribe_to_newsletter bool
    Is the user subscribed to the newsletter?
    tags string
    Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    time_zone string
    User time zone
    user_home string
    Home folder for FTP/SFTP. For users with the partnerRoot filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
    user_root string
    If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteRoot or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partnerRoot layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
    workspace_admin bool
    Is the user a Workspace administrator? Applicable only to the workspace ID related to this user, if one is set.
    workspace_id number
    Workspace ID
    username String
    User's username
    aiAssistantPersonalityId Integer
    AI Assistant Personality ID assigned directly to this user, if any.
    allowedIps String
    A list of allowed IPs if applicable. Newline delimited
    announcementsRead Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Signifies that the user has read all the announcements in the UI.
    attachmentsPermission Boolean
    If true, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
    authenticateUntil String
    Scheduled Date/Time at which user will be deactivated
    authenticationMethod String
    How is this user authenticated?
    avatarDelete Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, the avatar will be deleted.
    billingPermission Boolean
    Allow this user to perform operations on the account, payments, and invoices?
    bypassSiteAllowedIps Boolean
    Allow this user to skip site-wide IP blacklists?
    bypassUserLifecycleRules Boolean
    Exempt this user from user lifecycle rules?
    changePassword String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Used for changing a password on an existing user.
    changePasswordConfirmation String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in changePassword.
    company String
    User's company
    davPermission Boolean
    Can the user connect with WebDAV?
    defaultWorkspaceId Integer
    Workspace ID the user should land in by default when more than one Workspace is available.
    desktopConfigurationProfileId Integer
    Desktop Configuration Profile ID assigned directly to this user, if any.
    disabled Boolean
    Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
    email String
    User email address
    filesystemLayout String
    File system layout
    ftpPermission Boolean
    Can the user access with FTP/FTPS?
    grantPermission String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Permission to grant on the User Root upon user creation. Can be blank or full, read, write, list, read+write, or list+write
    groupId Integer
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Group ID to associate this user with.
    groupIds String
    Comma-separated list of group IDs of which this user is a member
    headerText String
    Text to display to the user in the header of the UI
    importedPasswordHash String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
    integrationCentricProfileId Integer
    Integration Centric Profile ID assigned directly to this user, if any.
    language String
    Preferred language
    name String
    User's full name
    notes String
    Any internal notes on the user
    notificationDailySendTime Integer
    Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
    notifyOnAllAutomationFailures Boolean
    Should the user receive automation failures via email?
    notifyOnAllExpectationFailures Boolean
    Should the user receive expectation failures and misses via email?
    notifyOnAllPendingWorkFailures Boolean
    Should the user receive pending work failures via email?
    notifyOnAllSiemHttpDestinationFailures Boolean
    Should the user receive siem failures via email?
    notifyOnAllSiteWarnings Boolean
    Should the user receive site warnings via email?
    notifyOnAllSsoFailures Boolean
    Should the user receive sso/scim/ldap configuration/sync failures via email?
    notifyOnAllSyncFailures Boolean
    Should the user receive sync failures via email?
    notifyOnAllUserSecurityEvents Boolean
    Should the user receive user security events via email?
    officeIntegrationEnabled Boolean
    Enable integration with Office for the web?
    partnerAdmin Boolean
    Is this user a Partner administrator?
    partnerId Integer
    Partner ID if this user belongs to a Partner
    password String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User password.
    passwordConfirmation String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in password.
    passwordValidityDays Integer
    Number of days to allow user to use the same password
    primaryGroupId Integer
    Primary group ID for Group Admin scoping
    readonlySiteAdmin Boolean
    Is the user an allowed to view all (non-billing) site configuration for this site?
    receiveAdminAlerts Boolean
    Deprecated. Use notifyOnAllSiteWarnings and granular failure notification preferences instead.
    require2fa String
    2FA required setting. useSystemSetting uses the site-wide setting, including SSO exemptions. alwaysRequire and neverRequire override the site-wide setting when user-level overrides are allowed.
    requireLoginBy String
    Require user to login by specified date otherwise it will be disabled.
    requirePasswordChange Boolean
    Is a password change required upon next user login?
    responsibleGroupId Integer
    ID of the internal Group responsible for this Partner User, overriding the Partner default.
    responsibleUserId Integer
    ID of the internal User responsible for this Partner User, overriding the Partner default.
    restapiPermission Boolean
    Can this user access the Web app, Desktop app, SDKs, or REST API? (All of these tools use the API internally, so this is one unified permission set.)
    selfManaged Boolean
    Does this user manage it's own credentials or is it a shared/bot user?
    sftpPermission Boolean
    Can the user access with SFTP?
    siteAdmin Boolean
    Is the user an administrator for this site?
    skipWelcomeScreen Boolean
    Skip Welcome page in the UI?
    sslRequired String
    SSL required setting
    ssoStrategyId Integer
    SSO (Single Sign On) strategy ID for the user, if applicable.
    subscribeToNewsletter Boolean
    Is the user subscribed to the newsletter?
    tags String
    Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    timeZone String
    User time zone
    userHome String
    Home folder for FTP/SFTP. For users with the partnerRoot filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
    userRoot String
    If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteRoot or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partnerRoot layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
    workspaceAdmin Boolean
    Is the user a Workspace administrator? Applicable only to the workspace ID related to this user, if one is set.
    workspaceId Integer
    Workspace ID
    username string
    User's username
    aiAssistantPersonalityId number
    AI Assistant Personality ID assigned directly to this user, if any.
    allowedIps string
    A list of allowed IPs if applicable. Newline delimited
    announcementsRead boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Signifies that the user has read all the announcements in the UI.
    attachmentsPermission boolean
    If true, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
    authenticateUntil string
    Scheduled Date/Time at which user will be deactivated
    authenticationMethod string
    How is this user authenticated?
    avatarDelete boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, the avatar will be deleted.
    billingPermission boolean
    Allow this user to perform operations on the account, payments, and invoices?
    bypassSiteAllowedIps boolean
    Allow this user to skip site-wide IP blacklists?
    bypassUserLifecycleRules boolean
    Exempt this user from user lifecycle rules?
    changePassword string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Used for changing a password on an existing user.
    changePasswordConfirmation string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in changePassword.
    company string
    User's company
    davPermission boolean
    Can the user connect with WebDAV?
    defaultWorkspaceId number
    Workspace ID the user should land in by default when more than one Workspace is available.
    desktopConfigurationProfileId number
    Desktop Configuration Profile ID assigned directly to this user, if any.
    disabled boolean
    Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
    email string
    User email address
    filesystemLayout string
    File system layout
    ftpPermission boolean
    Can the user access with FTP/FTPS?
    grantPermission string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Permission to grant on the User Root upon user creation. Can be blank or full, read, write, list, read+write, or list+write
    groupId number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Group ID to associate this user with.
    groupIds string
    Comma-separated list of group IDs of which this user is a member
    headerText string
    Text to display to the user in the header of the UI
    importedPasswordHash string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
    integrationCentricProfileId number
    Integration Centric Profile ID assigned directly to this user, if any.
    language string
    Preferred language
    name string
    User's full name
    notes string
    Any internal notes on the user
    notificationDailySendTime number
    Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
    notifyOnAllAutomationFailures boolean
    Should the user receive automation failures via email?
    notifyOnAllExpectationFailures boolean
    Should the user receive expectation failures and misses via email?
    notifyOnAllPendingWorkFailures boolean
    Should the user receive pending work failures via email?
    notifyOnAllSiemHttpDestinationFailures boolean
    Should the user receive siem failures via email?
    notifyOnAllSiteWarnings boolean
    Should the user receive site warnings via email?
    notifyOnAllSsoFailures boolean
    Should the user receive sso/scim/ldap configuration/sync failures via email?
    notifyOnAllSyncFailures boolean
    Should the user receive sync failures via email?
    notifyOnAllUserSecurityEvents boolean
    Should the user receive user security events via email?
    officeIntegrationEnabled boolean
    Enable integration with Office for the web?
    partnerAdmin boolean
    Is this user a Partner administrator?
    partnerId number
    Partner ID if this user belongs to a Partner
    password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User password.
    passwordConfirmation string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in password.
    passwordValidityDays number
    Number of days to allow user to use the same password
    primaryGroupId number
    Primary group ID for Group Admin scoping
    readonlySiteAdmin boolean
    Is the user an allowed to view all (non-billing) site configuration for this site?
    receiveAdminAlerts boolean
    Deprecated. Use notifyOnAllSiteWarnings and granular failure notification preferences instead.
    require2fa string
    2FA required setting. useSystemSetting uses the site-wide setting, including SSO exemptions. alwaysRequire and neverRequire override the site-wide setting when user-level overrides are allowed.
    requireLoginBy string
    Require user to login by specified date otherwise it will be disabled.
    requirePasswordChange boolean
    Is a password change required upon next user login?
    responsibleGroupId number
    ID of the internal Group responsible for this Partner User, overriding the Partner default.
    responsibleUserId number
    ID of the internal User responsible for this Partner User, overriding the Partner default.
    restapiPermission boolean
    Can this user access the Web app, Desktop app, SDKs, or REST API? (All of these tools use the API internally, so this is one unified permission set.)
    selfManaged boolean
    Does this user manage it's own credentials or is it a shared/bot user?
    sftpPermission boolean
    Can the user access with SFTP?
    siteAdmin boolean
    Is the user an administrator for this site?
    skipWelcomeScreen boolean
    Skip Welcome page in the UI?
    sslRequired string
    SSL required setting
    ssoStrategyId number
    SSO (Single Sign On) strategy ID for the user, if applicable.
    subscribeToNewsletter boolean
    Is the user subscribed to the newsletter?
    tags string
    Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    timeZone string
    User time zone
    userHome string
    Home folder for FTP/SFTP. For users with the partnerRoot filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
    userRoot string
    If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteRoot or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partnerRoot layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
    workspaceAdmin boolean
    Is the user a Workspace administrator? Applicable only to the workspace ID related to this user, if one is set.
    workspaceId number
    Workspace ID
    username str
    User's username
    ai_assistant_personality_id int
    AI Assistant Personality ID assigned directly to this user, if any.
    allowed_ips str
    A list of allowed IPs if applicable. Newline delimited
    announcements_read bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Signifies that the user has read all the announcements in the UI.
    attachments_permission bool
    If true, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
    authenticate_until str
    Scheduled Date/Time at which user will be deactivated
    authentication_method str
    How is this user authenticated?
    avatar_delete bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, the avatar will be deleted.
    billing_permission bool
    Allow this user to perform operations on the account, payments, and invoices?
    bypass_site_allowed_ips bool
    Allow this user to skip site-wide IP blacklists?
    bypass_user_lifecycle_rules bool
    Exempt this user from user lifecycle rules?
    change_password str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Used for changing a password on an existing user.
    change_password_confirmation str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in changePassword.
    company str
    User's company
    dav_permission bool
    Can the user connect with WebDAV?
    default_workspace_id int
    Workspace ID the user should land in by default when more than one Workspace is available.
    desktop_configuration_profile_id int
    Desktop Configuration Profile ID assigned directly to this user, if any.
    disabled bool
    Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
    email str
    User email address
    filesystem_layout str
    File system layout
    ftp_permission bool
    Can the user access with FTP/FTPS?
    grant_permission str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Permission to grant on the User Root upon user creation. Can be blank or full, read, write, list, read+write, or list+write
    group_id int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Group ID to associate this user with.
    group_ids str
    Comma-separated list of group IDs of which this user is a member
    header_text str
    Text to display to the user in the header of the UI
    imported_password_hash str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
    integration_centric_profile_id int
    Integration Centric Profile ID assigned directly to this user, if any.
    language str
    Preferred language
    name str
    User's full name
    notes str
    Any internal notes on the user
    notification_daily_send_time int
    Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
    notify_on_all_automation_failures bool
    Should the user receive automation failures via email?
    notify_on_all_expectation_failures bool
    Should the user receive expectation failures and misses via email?
    notify_on_all_pending_work_failures bool
    Should the user receive pending work failures via email?
    notify_on_all_siem_http_destination_failures bool
    Should the user receive siem failures via email?
    notify_on_all_site_warnings bool
    Should the user receive site warnings via email?
    notify_on_all_sso_failures bool
    Should the user receive sso/scim/ldap configuration/sync failures via email?
    notify_on_all_sync_failures bool
    Should the user receive sync failures via email?
    notify_on_all_user_security_events bool
    Should the user receive user security events via email?
    office_integration_enabled bool
    Enable integration with Office for the web?
    partner_admin bool
    Is this user a Partner administrator?
    partner_id int
    Partner ID if this user belongs to a Partner
    password str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User password.
    password_confirmation str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in password.
    password_validity_days int
    Number of days to allow user to use the same password
    primary_group_id int
    Primary group ID for Group Admin scoping
    readonly_site_admin bool
    Is the user an allowed to view all (non-billing) site configuration for this site?
    receive_admin_alerts bool
    Deprecated. Use notifyOnAllSiteWarnings and granular failure notification preferences instead.
    require2fa str
    2FA required setting. useSystemSetting uses the site-wide setting, including SSO exemptions. alwaysRequire and neverRequire override the site-wide setting when user-level overrides are allowed.
    require_login_by str
    Require user to login by specified date otherwise it will be disabled.
    require_password_change bool
    Is a password change required upon next user login?
    responsible_group_id int
    ID of the internal Group responsible for this Partner User, overriding the Partner default.
    responsible_user_id int
    ID of the internal User responsible for this Partner User, overriding the Partner default.
    restapi_permission bool
    Can this user access the Web app, Desktop app, SDKs, or REST API? (All of these tools use the API internally, so this is one unified permission set.)
    self_managed bool
    Does this user manage it's own credentials or is it a shared/bot user?
    sftp_permission bool
    Can the user access with SFTP?
    site_admin bool
    Is the user an administrator for this site?
    skip_welcome_screen bool
    Skip Welcome page in the UI?
    ssl_required str
    SSL required setting
    sso_strategy_id int
    SSO (Single Sign On) strategy ID for the user, if applicable.
    subscribe_to_newsletter bool
    Is the user subscribed to the newsletter?
    tags str
    Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    time_zone str
    User time zone
    user_home str
    Home folder for FTP/SFTP. For users with the partnerRoot filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
    user_root str
    If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteRoot or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partnerRoot layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
    workspace_admin bool
    Is the user a Workspace administrator? Applicable only to the workspace ID related to this user, if one is set.
    workspace_id int
    Workspace ID
    username String
    User's username
    aiAssistantPersonalityId Number
    AI Assistant Personality ID assigned directly to this user, if any.
    allowedIps String
    A list of allowed IPs if applicable. Newline delimited
    announcementsRead Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Signifies that the user has read all the announcements in the UI.
    attachmentsPermission Boolean
    If true, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
    authenticateUntil String
    Scheduled Date/Time at which user will be deactivated
    authenticationMethod String
    How is this user authenticated?
    avatarDelete Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, the avatar will be deleted.
    billingPermission Boolean
    Allow this user to perform operations on the account, payments, and invoices?
    bypassSiteAllowedIps Boolean
    Allow this user to skip site-wide IP blacklists?
    bypassUserLifecycleRules Boolean
    Exempt this user from user lifecycle rules?
    changePassword String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Used for changing a password on an existing user.
    changePasswordConfirmation String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in changePassword.
    company String
    User's company
    davPermission Boolean
    Can the user connect with WebDAV?
    defaultWorkspaceId Number
    Workspace ID the user should land in by default when more than one Workspace is available.
    desktopConfigurationProfileId Number
    Desktop Configuration Profile ID assigned directly to this user, if any.
    disabled Boolean
    Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
    email String
    User email address
    filesystemLayout String
    File system layout
    ftpPermission Boolean
    Can the user access with FTP/FTPS?
    grantPermission String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Permission to grant on the User Root upon user creation. Can be blank or full, read, write, list, read+write, or list+write
    groupId Number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Group ID to associate this user with.
    groupIds String
    Comma-separated list of group IDs of which this user is a member
    headerText String
    Text to display to the user in the header of the UI
    importedPasswordHash String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
    integrationCentricProfileId Number
    Integration Centric Profile ID assigned directly to this user, if any.
    language String
    Preferred language
    name String
    User's full name
    notes String
    Any internal notes on the user
    notificationDailySendTime Number
    Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
    notifyOnAllAutomationFailures Boolean
    Should the user receive automation failures via email?
    notifyOnAllExpectationFailures Boolean
    Should the user receive expectation failures and misses via email?
    notifyOnAllPendingWorkFailures Boolean
    Should the user receive pending work failures via email?
    notifyOnAllSiemHttpDestinationFailures Boolean
    Should the user receive siem failures via email?
    notifyOnAllSiteWarnings Boolean
    Should the user receive site warnings via email?
    notifyOnAllSsoFailures Boolean
    Should the user receive sso/scim/ldap configuration/sync failures via email?
    notifyOnAllSyncFailures Boolean
    Should the user receive sync failures via email?
    notifyOnAllUserSecurityEvents Boolean
    Should the user receive user security events via email?
    officeIntegrationEnabled Boolean
    Enable integration with Office for the web?
    partnerAdmin Boolean
    Is this user a Partner administrator?
    partnerId Number
    Partner ID if this user belongs to a Partner
    password String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User password.
    passwordConfirmation String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in password.
    passwordValidityDays Number
    Number of days to allow user to use the same password
    primaryGroupId Number
    Primary group ID for Group Admin scoping
    readonlySiteAdmin Boolean
    Is the user an allowed to view all (non-billing) site configuration for this site?
    receiveAdminAlerts Boolean
    Deprecated. Use notifyOnAllSiteWarnings and granular failure notification preferences instead.
    require2fa String
    2FA required setting. useSystemSetting uses the site-wide setting, including SSO exemptions. alwaysRequire and neverRequire override the site-wide setting when user-level overrides are allowed.
    requireLoginBy String
    Require user to login by specified date otherwise it will be disabled.
    requirePasswordChange Boolean
    Is a password change required upon next user login?
    responsibleGroupId Number
    ID of the internal Group responsible for this Partner User, overriding the Partner default.
    responsibleUserId Number
    ID of the internal User responsible for this Partner User, overriding the Partner default.
    restapiPermission Boolean
    Can this user access the Web app, Desktop app, SDKs, or REST API? (All of these tools use the API internally, so this is one unified permission set.)
    selfManaged Boolean
    Does this user manage it's own credentials or is it a shared/bot user?
    sftpPermission Boolean
    Can the user access with SFTP?
    siteAdmin Boolean
    Is the user an administrator for this site?
    skipWelcomeScreen Boolean
    Skip Welcome page in the UI?
    sslRequired String
    SSL required setting
    ssoStrategyId Number
    SSO (Single Sign On) strategy ID for the user, if applicable.
    subscribeToNewsletter Boolean
    Is the user subscribed to the newsletter?
    tags String
    Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    timeZone String
    User time zone
    userHome String
    Home folder for FTP/SFTP. For users with the partnerRoot filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
    userRoot String
    If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteRoot or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partnerRoot layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
    workspaceAdmin Boolean
    Is the user a Workspace administrator? Applicable only to the workspace ID related to this user, if one is set.
    workspaceId Number
    Workspace ID

    Outputs

    All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

    Active2fa bool
    Is 2fa active for the user?
    AdminGroupIds List<int>
    List of group IDs of which this user is an administrator
    ApiKeysCount int
    Number of API keys associated with this user
    AvatarUrl string
    URL holding the user's avatar
    Billable bool
    Is this a billable user record?
    CreatedAt string
    When this user was created
    DaysRemainingUntilPasswordExpire int
    Number of days remaining until password expires
    DisabledExpiredOrInactive bool
    Computed property that returns true if user disabled or expired or inactive.
    ExternallyManaged bool
    Is this user managed by a SsoStrategy?
    FirstLoginAt string
    User's first login time
    Id string
    The provider-assigned unique ID for this managed resource.
    LastActiveAt string
    User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation
    LastApiUseAt string
    User's most recent API use time
    LastDavLoginAt string
    User's most recent login time via WebDAV
    LastDesktopLoginAt string
    User's most recent login time via Desktop app
    LastFtpLoginAt string
    User's most recent login time via FTP
    LastLoginAt string
    User's most recent login time via any protocol
    LastProtocolCipher string
    The most recent protocol and cipher used
    LastRestapiLoginAt string
    User's most recent login time via Rest API
    LastSftpLoginAt string
    User's most recent login time via SFTP
    LastWebLoginAt string
    User's most recent login time via web
    LockoutExpires string
    Time in the future that the user will no longer be locked out if applicable
    PartnerName string
    Name of the Partner if this user belongs to a Partner
    PasswordExpireAt string
    Password expiration datetime
    PasswordExpired bool
    Is user's password expired?
    PasswordSetAt string
    Last time the user's password was set
    PublicKeysCount int
    Number of public keys associated with this user
    SiteId int
    Site ID
    TypeOf2fa string
    Type(s) of 2FA methods in use, for programmatic use. Will be either sms, totp, webauthn, yubi, email, or multiple values sorted alphabetically and joined by an underscore. Does not specify whether user has more than one of a given method.
    TypeOf2faForDisplay string
    Type(s) of 2FA methods in use, formatted for displaying in the UI. Unlike typeOf2fa, this value will make clear when a user has more than 1 of the same type of method.
    Active2fa bool
    Is 2fa active for the user?
    AdminGroupIds []int
    List of group IDs of which this user is an administrator
    ApiKeysCount int
    Number of API keys associated with this user
    AvatarUrl string
    URL holding the user's avatar
    Billable bool
    Is this a billable user record?
    CreatedAt string
    When this user was created
    DaysRemainingUntilPasswordExpire int
    Number of days remaining until password expires
    DisabledExpiredOrInactive bool
    Computed property that returns true if user disabled or expired or inactive.
    ExternallyManaged bool
    Is this user managed by a SsoStrategy?
    FirstLoginAt string
    User's first login time
    Id string
    The provider-assigned unique ID for this managed resource.
    LastActiveAt string
    User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation
    LastApiUseAt string
    User's most recent API use time
    LastDavLoginAt string
    User's most recent login time via WebDAV
    LastDesktopLoginAt string
    User's most recent login time via Desktop app
    LastFtpLoginAt string
    User's most recent login time via FTP
    LastLoginAt string
    User's most recent login time via any protocol
    LastProtocolCipher string
    The most recent protocol and cipher used
    LastRestapiLoginAt string
    User's most recent login time via Rest API
    LastSftpLoginAt string
    User's most recent login time via SFTP
    LastWebLoginAt string
    User's most recent login time via web
    LockoutExpires string
    Time in the future that the user will no longer be locked out if applicable
    PartnerName string
    Name of the Partner if this user belongs to a Partner
    PasswordExpireAt string
    Password expiration datetime
    PasswordExpired bool
    Is user's password expired?
    PasswordSetAt string
    Last time the user's password was set
    PublicKeysCount int
    Number of public keys associated with this user
    SiteId int
    Site ID
    TypeOf2fa string
    Type(s) of 2FA methods in use, for programmatic use. Will be either sms, totp, webauthn, yubi, email, or multiple values sorted alphabetically and joined by an underscore. Does not specify whether user has more than one of a given method.
    TypeOf2faForDisplay string
    Type(s) of 2FA methods in use, formatted for displaying in the UI. Unlike typeOf2fa, this value will make clear when a user has more than 1 of the same type of method.
    active2fa bool
    Is 2fa active for the user?
    admin_group_ids list(number)
    List of group IDs of which this user is an administrator
    api_keys_count number
    Number of API keys associated with this user
    avatar_url string
    URL holding the user's avatar
    billable bool
    Is this a billable user record?
    created_at string
    When this user was created
    days_remaining_until_password_expire number
    Number of days remaining until password expires
    disabled_expired_or_inactive bool
    Computed property that returns true if user disabled or expired or inactive.
    externally_managed bool
    Is this user managed by a SsoStrategy?
    first_login_at string
    User's first login time
    id string
    The provider-assigned unique ID for this managed resource.
    last_active_at string
    User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation
    last_api_use_at string
    User's most recent API use time
    last_dav_login_at string
    User's most recent login time via WebDAV
    last_desktop_login_at string
    User's most recent login time via Desktop app
    last_ftp_login_at string
    User's most recent login time via FTP
    last_login_at string
    User's most recent login time via any protocol
    last_protocol_cipher string
    The most recent protocol and cipher used
    last_restapi_login_at string
    User's most recent login time via Rest API
    last_sftp_login_at string
    User's most recent login time via SFTP
    last_web_login_at string
    User's most recent login time via web
    lockout_expires string
    Time in the future that the user will no longer be locked out if applicable
    partner_name string
    Name of the Partner if this user belongs to a Partner
    password_expire_at string
    Password expiration datetime
    password_expired bool
    Is user's password expired?
    password_set_at string
    Last time the user's password was set
    public_keys_count number
    Number of public keys associated with this user
    site_id number
    Site ID
    type_of2fa string
    Type(s) of 2FA methods in use, for programmatic use. Will be either sms, totp, webauthn, yubi, email, or multiple values sorted alphabetically and joined by an underscore. Does not specify whether user has more than one of a given method.
    type_of2fa_for_display string
    Type(s) of 2FA methods in use, formatted for displaying in the UI. Unlike typeOf2fa, this value will make clear when a user has more than 1 of the same type of method.
    active2fa Boolean
    Is 2fa active for the user?
    adminGroupIds List<Integer>
    List of group IDs of which this user is an administrator
    apiKeysCount Integer
    Number of API keys associated with this user
    avatarUrl String
    URL holding the user's avatar
    billable Boolean
    Is this a billable user record?
    createdAt String
    When this user was created
    daysRemainingUntilPasswordExpire Integer
    Number of days remaining until password expires
    disabledExpiredOrInactive Boolean
    Computed property that returns true if user disabled or expired or inactive.
    externallyManaged Boolean
    Is this user managed by a SsoStrategy?
    firstLoginAt String
    User's first login time
    id String
    The provider-assigned unique ID for this managed resource.
    lastActiveAt String
    User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation
    lastApiUseAt String
    User's most recent API use time
    lastDavLoginAt String
    User's most recent login time via WebDAV
    lastDesktopLoginAt String
    User's most recent login time via Desktop app
    lastFtpLoginAt String
    User's most recent login time via FTP
    lastLoginAt String
    User's most recent login time via any protocol
    lastProtocolCipher String
    The most recent protocol and cipher used
    lastRestapiLoginAt String
    User's most recent login time via Rest API
    lastSftpLoginAt String
    User's most recent login time via SFTP
    lastWebLoginAt String
    User's most recent login time via web
    lockoutExpires String
    Time in the future that the user will no longer be locked out if applicable
    partnerName String
    Name of the Partner if this user belongs to a Partner
    passwordExpireAt String
    Password expiration datetime
    passwordExpired Boolean
    Is user's password expired?
    passwordSetAt String
    Last time the user's password was set
    publicKeysCount Integer
    Number of public keys associated with this user
    siteId Integer
    Site ID
    typeOf2fa String
    Type(s) of 2FA methods in use, for programmatic use. Will be either sms, totp, webauthn, yubi, email, or multiple values sorted alphabetically and joined by an underscore. Does not specify whether user has more than one of a given method.
    typeOf2faForDisplay String
    Type(s) of 2FA methods in use, formatted for displaying in the UI. Unlike typeOf2fa, this value will make clear when a user has more than 1 of the same type of method.
    active2fa boolean
    Is 2fa active for the user?
    adminGroupIds number[]
    List of group IDs of which this user is an administrator
    apiKeysCount number
    Number of API keys associated with this user
    avatarUrl string
    URL holding the user's avatar
    billable boolean
    Is this a billable user record?
    createdAt string
    When this user was created
    daysRemainingUntilPasswordExpire number
    Number of days remaining until password expires
    disabledExpiredOrInactive boolean
    Computed property that returns true if user disabled or expired or inactive.
    externallyManaged boolean
    Is this user managed by a SsoStrategy?
    firstLoginAt string
    User's first login time
    id string
    The provider-assigned unique ID for this managed resource.
    lastActiveAt string
    User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation
    lastApiUseAt string
    User's most recent API use time
    lastDavLoginAt string
    User's most recent login time via WebDAV
    lastDesktopLoginAt string
    User's most recent login time via Desktop app
    lastFtpLoginAt string
    User's most recent login time via FTP
    lastLoginAt string
    User's most recent login time via any protocol
    lastProtocolCipher string
    The most recent protocol and cipher used
    lastRestapiLoginAt string
    User's most recent login time via Rest API
    lastSftpLoginAt string
    User's most recent login time via SFTP
    lastWebLoginAt string
    User's most recent login time via web
    lockoutExpires string
    Time in the future that the user will no longer be locked out if applicable
    partnerName string
    Name of the Partner if this user belongs to a Partner
    passwordExpireAt string
    Password expiration datetime
    passwordExpired boolean
    Is user's password expired?
    passwordSetAt string
    Last time the user's password was set
    publicKeysCount number
    Number of public keys associated with this user
    siteId number
    Site ID
    typeOf2fa string
    Type(s) of 2FA methods in use, for programmatic use. Will be either sms, totp, webauthn, yubi, email, or multiple values sorted alphabetically and joined by an underscore. Does not specify whether user has more than one of a given method.
    typeOf2faForDisplay string
    Type(s) of 2FA methods in use, formatted for displaying in the UI. Unlike typeOf2fa, this value will make clear when a user has more than 1 of the same type of method.
    active2fa bool
    Is 2fa active for the user?
    admin_group_ids Sequence[int]
    List of group IDs of which this user is an administrator
    api_keys_count int
    Number of API keys associated with this user
    avatar_url str
    URL holding the user's avatar
    billable bool
    Is this a billable user record?
    created_at str
    When this user was created
    days_remaining_until_password_expire int
    Number of days remaining until password expires
    disabled_expired_or_inactive bool
    Computed property that returns true if user disabled or expired or inactive.
    externally_managed bool
    Is this user managed by a SsoStrategy?
    first_login_at str
    User's first login time
    id str
    The provider-assigned unique ID for this managed resource.
    last_active_at str
    User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation
    last_api_use_at str
    User's most recent API use time
    last_dav_login_at str
    User's most recent login time via WebDAV
    last_desktop_login_at str
    User's most recent login time via Desktop app
    last_ftp_login_at str
    User's most recent login time via FTP
    last_login_at str
    User's most recent login time via any protocol
    last_protocol_cipher str
    The most recent protocol and cipher used
    last_restapi_login_at str
    User's most recent login time via Rest API
    last_sftp_login_at str
    User's most recent login time via SFTP
    last_web_login_at str
    User's most recent login time via web
    lockout_expires str
    Time in the future that the user will no longer be locked out if applicable
    partner_name str
    Name of the Partner if this user belongs to a Partner
    password_expire_at str
    Password expiration datetime
    password_expired bool
    Is user's password expired?
    password_set_at str
    Last time the user's password was set
    public_keys_count int
    Number of public keys associated with this user
    site_id int
    Site ID
    type_of2fa str
    Type(s) of 2FA methods in use, for programmatic use. Will be either sms, totp, webauthn, yubi, email, or multiple values sorted alphabetically and joined by an underscore. Does not specify whether user has more than one of a given method.
    type_of2fa_for_display str
    Type(s) of 2FA methods in use, formatted for displaying in the UI. Unlike typeOf2fa, this value will make clear when a user has more than 1 of the same type of method.
    active2fa Boolean
    Is 2fa active for the user?
    adminGroupIds List<Number>
    List of group IDs of which this user is an administrator
    apiKeysCount Number
    Number of API keys associated with this user
    avatarUrl String
    URL holding the user's avatar
    billable Boolean
    Is this a billable user record?
    createdAt String
    When this user was created
    daysRemainingUntilPasswordExpire Number
    Number of days remaining until password expires
    disabledExpiredOrInactive Boolean
    Computed property that returns true if user disabled or expired or inactive.
    externallyManaged Boolean
    Is this user managed by a SsoStrategy?
    firstLoginAt String
    User's first login time
    id String
    The provider-assigned unique ID for this managed resource.
    lastActiveAt String
    User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation
    lastApiUseAt String
    User's most recent API use time
    lastDavLoginAt String
    User's most recent login time via WebDAV
    lastDesktopLoginAt String
    User's most recent login time via Desktop app
    lastFtpLoginAt String
    User's most recent login time via FTP
    lastLoginAt String
    User's most recent login time via any protocol
    lastProtocolCipher String
    The most recent protocol and cipher used
    lastRestapiLoginAt String
    User's most recent login time via Rest API
    lastSftpLoginAt String
    User's most recent login time via SFTP
    lastWebLoginAt String
    User's most recent login time via web
    lockoutExpires String
    Time in the future that the user will no longer be locked out if applicable
    partnerName String
    Name of the Partner if this user belongs to a Partner
    passwordExpireAt String
    Password expiration datetime
    passwordExpired Boolean
    Is user's password expired?
    passwordSetAt String
    Last time the user's password was set
    publicKeysCount Number
    Number of public keys associated with this user
    siteId Number
    Site ID
    typeOf2fa String
    Type(s) of 2FA methods in use, for programmatic use. Will be either sms, totp, webauthn, yubi, email, or multiple values sorted alphabetically and joined by an underscore. Does not specify whether user has more than one of a given method.
    typeOf2faForDisplay String
    Type(s) of 2FA methods in use, formatted for displaying in the UI. Unlike typeOf2fa, this value will make clear when a user has more than 1 of the same type of method.

    Look up Existing User Resource

    Get an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: UserState, opts?: CustomResourceOptions): User
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active2fa: Optional[bool] = None,
        admin_group_ids: Optional[Sequence[int]] = None,
        ai_assistant_personality_id: Optional[int] = None,
        allowed_ips: Optional[str] = None,
        announcements_read: Optional[bool] = None,
        api_keys_count: Optional[int] = None,
        attachments_permission: Optional[bool] = None,
        authenticate_until: Optional[str] = None,
        authentication_method: Optional[str] = None,
        avatar_delete: Optional[bool] = None,
        avatar_url: Optional[str] = None,
        billable: Optional[bool] = None,
        billing_permission: Optional[bool] = None,
        bypass_site_allowed_ips: Optional[bool] = None,
        bypass_user_lifecycle_rules: Optional[bool] = None,
        change_password: Optional[str] = None,
        change_password_confirmation: Optional[str] = None,
        company: Optional[str] = None,
        created_at: Optional[str] = None,
        dav_permission: Optional[bool] = None,
        days_remaining_until_password_expire: Optional[int] = None,
        default_workspace_id: Optional[int] = None,
        desktop_configuration_profile_id: Optional[int] = None,
        disabled: Optional[bool] = None,
        disabled_expired_or_inactive: Optional[bool] = None,
        email: Optional[str] = None,
        externally_managed: Optional[bool] = None,
        filesystem_layout: Optional[str] = None,
        first_login_at: Optional[str] = None,
        ftp_permission: Optional[bool] = None,
        grant_permission: Optional[str] = None,
        group_id: Optional[int] = None,
        group_ids: Optional[str] = None,
        header_text: Optional[str] = None,
        imported_password_hash: Optional[str] = None,
        integration_centric_profile_id: Optional[int] = None,
        language: Optional[str] = None,
        last_active_at: Optional[str] = None,
        last_api_use_at: Optional[str] = None,
        last_dav_login_at: Optional[str] = None,
        last_desktop_login_at: Optional[str] = None,
        last_ftp_login_at: Optional[str] = None,
        last_login_at: Optional[str] = None,
        last_protocol_cipher: Optional[str] = None,
        last_restapi_login_at: Optional[str] = None,
        last_sftp_login_at: Optional[str] = None,
        last_web_login_at: Optional[str] = None,
        lockout_expires: Optional[str] = None,
        name: Optional[str] = None,
        notes: Optional[str] = None,
        notification_daily_send_time: Optional[int] = None,
        notify_on_all_automation_failures: Optional[bool] = None,
        notify_on_all_expectation_failures: Optional[bool] = None,
        notify_on_all_pending_work_failures: Optional[bool] = None,
        notify_on_all_siem_http_destination_failures: Optional[bool] = None,
        notify_on_all_site_warnings: Optional[bool] = None,
        notify_on_all_sso_failures: Optional[bool] = None,
        notify_on_all_sync_failures: Optional[bool] = None,
        notify_on_all_user_security_events: Optional[bool] = None,
        office_integration_enabled: Optional[bool] = None,
        partner_admin: Optional[bool] = None,
        partner_id: Optional[int] = None,
        partner_name: Optional[str] = None,
        password: Optional[str] = None,
        password_confirmation: Optional[str] = None,
        password_expire_at: Optional[str] = None,
        password_expired: Optional[bool] = None,
        password_set_at: Optional[str] = None,
        password_validity_days: Optional[int] = None,
        primary_group_id: Optional[int] = None,
        public_keys_count: Optional[int] = None,
        readonly_site_admin: Optional[bool] = None,
        receive_admin_alerts: Optional[bool] = None,
        require2fa: Optional[str] = None,
        require_login_by: Optional[str] = None,
        require_password_change: Optional[bool] = None,
        responsible_group_id: Optional[int] = None,
        responsible_user_id: Optional[int] = None,
        restapi_permission: Optional[bool] = None,
        self_managed: Optional[bool] = None,
        sftp_permission: Optional[bool] = None,
        site_admin: Optional[bool] = None,
        site_id: Optional[int] = None,
        skip_welcome_screen: Optional[bool] = None,
        ssl_required: Optional[str] = None,
        sso_strategy_id: Optional[int] = None,
        subscribe_to_newsletter: Optional[bool] = None,
        tags: Optional[str] = None,
        time_zone: Optional[str] = None,
        type_of2fa: Optional[str] = None,
        type_of2fa_for_display: Optional[str] = None,
        user_home: Optional[str] = None,
        user_root: Optional[str] = None,
        username: Optional[str] = None,
        workspace_admin: Optional[bool] = None,
        workspace_id: Optional[int] = None) -> User
    func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
    public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
    public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
    resources:  _:    type: filescom:User    get:      id: ${id}
    import {
  to = filescom_user.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Active2fa bool
    Is 2fa active for the user?
    AdminGroupIds List<int>
    List of group IDs of which this user is an administrator
    AiAssistantPersonalityId int
    AI Assistant Personality ID assigned directly to this user, if any.
    AllowedIps string
    A list of allowed IPs if applicable. Newline delimited
    AnnouncementsRead bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Signifies that the user has read all the announcements in the UI.
    ApiKeysCount int
    Number of API keys associated with this user
    AttachmentsPermission bool
    If true, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
    AuthenticateUntil string
    Scheduled Date/Time at which user will be deactivated
    AuthenticationMethod string
    How is this user authenticated?
    AvatarDelete bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, the avatar will be deleted.
    AvatarUrl string
    URL holding the user's avatar
    Billable bool
    Is this a billable user record?
    BillingPermission bool
    Allow this user to perform operations on the account, payments, and invoices?
    BypassSiteAllowedIps bool
    Allow this user to skip site-wide IP blacklists?
    BypassUserLifecycleRules bool
    Exempt this user from user lifecycle rules?
    ChangePassword string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Used for changing a password on an existing user.
    ChangePasswordConfirmation string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in changePassword.
    Company string
    User's company
    CreatedAt string
    When this user was created
    DavPermission bool
    Can the user connect with WebDAV?
    DaysRemainingUntilPasswordExpire int
    Number of days remaining until password expires
    DefaultWorkspaceId int
    Workspace ID the user should land in by default when more than one Workspace is available.
    DesktopConfigurationProfileId int
    Desktop Configuration Profile ID assigned directly to this user, if any.
    Disabled bool
    Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
    DisabledExpiredOrInactive bool
    Computed property that returns true if user disabled or expired or inactive.
    Email string
    User email address
    ExternallyManaged bool
    Is this user managed by a SsoStrategy?
    FilesystemLayout string
    File system layout
    FirstLoginAt string
    User's first login time
    FtpPermission bool
    Can the user access with FTP/FTPS?
    GrantPermission string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Permission to grant on the User Root upon user creation. Can be blank or full, read, write, list, read+write, or list+write
    GroupId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Group ID to associate this user with.
    GroupIds string
    Comma-separated list of group IDs of which this user is a member
    HeaderText string
    Text to display to the user in the header of the UI
    ImportedPasswordHash string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
    IntegrationCentricProfileId int
    Integration Centric Profile ID assigned directly to this user, if any.
    Language string
    Preferred language
    LastActiveAt string
    User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation
    LastApiUseAt string
    User's most recent API use time
    LastDavLoginAt string
    User's most recent login time via WebDAV
    LastDesktopLoginAt string
    User's most recent login time via Desktop app
    LastFtpLoginAt string
    User's most recent login time via FTP
    LastLoginAt string
    User's most recent login time via any protocol
    LastProtocolCipher string
    The most recent protocol and cipher used
    LastRestapiLoginAt string
    User's most recent login time via Rest API
    LastSftpLoginAt string
    User's most recent login time via SFTP
    LastWebLoginAt string
    User's most recent login time via web
    LockoutExpires string
    Time in the future that the user will no longer be locked out if applicable
    Name string
    User's full name
    Notes string
    Any internal notes on the user
    NotificationDailySendTime int
    Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
    NotifyOnAllAutomationFailures bool
    Should the user receive automation failures via email?
    NotifyOnAllExpectationFailures bool
    Should the user receive expectation failures and misses via email?
    NotifyOnAllPendingWorkFailures bool
    Should the user receive pending work failures via email?
    NotifyOnAllSiemHttpDestinationFailures bool
    Should the user receive siem failures via email?
    NotifyOnAllSiteWarnings bool
    Should the user receive site warnings via email?
    NotifyOnAllSsoFailures bool
    Should the user receive sso/scim/ldap configuration/sync failures via email?
    NotifyOnAllSyncFailures bool
    Should the user receive sync failures via email?
    NotifyOnAllUserSecurityEvents bool
    Should the user receive user security events via email?
    OfficeIntegrationEnabled bool
    Enable integration with Office for the web?
    PartnerAdmin bool
    Is this user a Partner administrator?
    PartnerId int
    Partner ID if this user belongs to a Partner
    PartnerName string
    Name of the Partner if this user belongs to a Partner
    Password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User password.
    PasswordConfirmation string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in password.
    PasswordExpireAt string
    Password expiration datetime
    PasswordExpired bool
    Is user's password expired?
    PasswordSetAt string
    Last time the user's password was set
    PasswordValidityDays int
    Number of days to allow user to use the same password
    PrimaryGroupId int
    Primary group ID for Group Admin scoping
    PublicKeysCount int
    Number of public keys associated with this user
    ReadonlySiteAdmin bool
    Is the user an allowed to view all (non-billing) site configuration for this site?
    ReceiveAdminAlerts bool
    Deprecated. Use notifyOnAllSiteWarnings and granular failure notification preferences instead.
    Require2fa string
    2FA required setting. useSystemSetting uses the site-wide setting, including SSO exemptions. alwaysRequire and neverRequire override the site-wide setting when user-level overrides are allowed.
    RequireLoginBy string
    Require user to login by specified date otherwise it will be disabled.
    RequirePasswordChange bool
    Is a password change required upon next user login?
    ResponsibleGroupId int
    ID of the internal Group responsible for this Partner User, overriding the Partner default.
    ResponsibleUserId int
    ID of the internal User responsible for this Partner User, overriding the Partner default.
    RestapiPermission bool
    Can this user access the Web app, Desktop app, SDKs, or REST API? (All of these tools use the API internally, so this is one unified permission set.)
    SelfManaged bool
    Does this user manage it's own credentials or is it a shared/bot user?
    SftpPermission bool
    Can the user access with SFTP?
    SiteAdmin bool
    Is the user an administrator for this site?
    SiteId int
    Site ID
    SkipWelcomeScreen bool
    Skip Welcome page in the UI?
    SslRequired string
    SSL required setting
    SsoStrategyId int
    SSO (Single Sign On) strategy ID for the user, if applicable.
    SubscribeToNewsletter bool
    Is the user subscribed to the newsletter?
    Tags string
    Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    TimeZone string
    User time zone
    TypeOf2fa string
    Type(s) of 2FA methods in use, for programmatic use. Will be either sms, totp, webauthn, yubi, email, or multiple values sorted alphabetically and joined by an underscore. Does not specify whether user has more than one of a given method.
    TypeOf2faForDisplay string
    Type(s) of 2FA methods in use, formatted for displaying in the UI. Unlike typeOf2fa, this value will make clear when a user has more than 1 of the same type of method.
    UserHome string
    Home folder for FTP/SFTP. For users with the partnerRoot filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
    UserRoot string
    If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteRoot or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partnerRoot layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
    Username string
    User's username
    WorkspaceAdmin bool
    Is the user a Workspace administrator? Applicable only to the workspace ID related to this user, if one is set.
    WorkspaceId int
    Workspace ID
    Active2fa bool
    Is 2fa active for the user?
    AdminGroupIds []int
    List of group IDs of which this user is an administrator
    AiAssistantPersonalityId int
    AI Assistant Personality ID assigned directly to this user, if any.
    AllowedIps string
    A list of allowed IPs if applicable. Newline delimited
    AnnouncementsRead bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Signifies that the user has read all the announcements in the UI.
    ApiKeysCount int
    Number of API keys associated with this user
    AttachmentsPermission bool
    If true, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
    AuthenticateUntil string
    Scheduled Date/Time at which user will be deactivated
    AuthenticationMethod string
    How is this user authenticated?
    AvatarDelete bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, the avatar will be deleted.
    AvatarUrl string
    URL holding the user's avatar
    Billable bool
    Is this a billable user record?
    BillingPermission bool
    Allow this user to perform operations on the account, payments, and invoices?
    BypassSiteAllowedIps bool
    Allow this user to skip site-wide IP blacklists?
    BypassUserLifecycleRules bool
    Exempt this user from user lifecycle rules?
    ChangePassword string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Used for changing a password on an existing user.
    ChangePasswordConfirmation string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in changePassword.
    Company string
    User's company
    CreatedAt string
    When this user was created
    DavPermission bool
    Can the user connect with WebDAV?
    DaysRemainingUntilPasswordExpire int
    Number of days remaining until password expires
    DefaultWorkspaceId int
    Workspace ID the user should land in by default when more than one Workspace is available.
    DesktopConfigurationProfileId int
    Desktop Configuration Profile ID assigned directly to this user, if any.
    Disabled bool
    Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
    DisabledExpiredOrInactive bool
    Computed property that returns true if user disabled or expired or inactive.
    Email string
    User email address
    ExternallyManaged bool
    Is this user managed by a SsoStrategy?
    FilesystemLayout string
    File system layout
    FirstLoginAt string
    User's first login time
    FtpPermission bool
    Can the user access with FTP/FTPS?
    GrantPermission string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Permission to grant on the User Root upon user creation. Can be blank or full, read, write, list, read+write, or list+write
    GroupId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Group ID to associate this user with.
    GroupIds string
    Comma-separated list of group IDs of which this user is a member
    HeaderText string
    Text to display to the user in the header of the UI
    ImportedPasswordHash string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
    IntegrationCentricProfileId int
    Integration Centric Profile ID assigned directly to this user, if any.
    Language string
    Preferred language
    LastActiveAt string
    User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation
    LastApiUseAt string
    User's most recent API use time
    LastDavLoginAt string
    User's most recent login time via WebDAV
    LastDesktopLoginAt string
    User's most recent login time via Desktop app
    LastFtpLoginAt string
    User's most recent login time via FTP
    LastLoginAt string
    User's most recent login time via any protocol
    LastProtocolCipher string
    The most recent protocol and cipher used
    LastRestapiLoginAt string
    User's most recent login time via Rest API
    LastSftpLoginAt string
    User's most recent login time via SFTP
    LastWebLoginAt string
    User's most recent login time via web
    LockoutExpires string
    Time in the future that the user will no longer be locked out if applicable
    Name string
    User's full name
    Notes string
    Any internal notes on the user
    NotificationDailySendTime int
    Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
    NotifyOnAllAutomationFailures bool
    Should the user receive automation failures via email?
    NotifyOnAllExpectationFailures bool
    Should the user receive expectation failures and misses via email?
    NotifyOnAllPendingWorkFailures bool
    Should the user receive pending work failures via email?
    NotifyOnAllSiemHttpDestinationFailures bool
    Should the user receive siem failures via email?
    NotifyOnAllSiteWarnings bool
    Should the user receive site warnings via email?
    NotifyOnAllSsoFailures bool
    Should the user receive sso/scim/ldap configuration/sync failures via email?
    NotifyOnAllSyncFailures bool
    Should the user receive sync failures via email?
    NotifyOnAllUserSecurityEvents bool
    Should the user receive user security events via email?
    OfficeIntegrationEnabled bool
    Enable integration with Office for the web?
    PartnerAdmin bool
    Is this user a Partner administrator?
    PartnerId int
    Partner ID if this user belongs to a Partner
    PartnerName string
    Name of the Partner if this user belongs to a Partner
    Password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User password.
    PasswordConfirmation string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in password.
    PasswordExpireAt string
    Password expiration datetime
    PasswordExpired bool
    Is user's password expired?
    PasswordSetAt string
    Last time the user's password was set
    PasswordValidityDays int
    Number of days to allow user to use the same password
    PrimaryGroupId int
    Primary group ID for Group Admin scoping
    PublicKeysCount int
    Number of public keys associated with this user
    ReadonlySiteAdmin bool
    Is the user an allowed to view all (non-billing) site configuration for this site?
    ReceiveAdminAlerts bool
    Deprecated. Use notifyOnAllSiteWarnings and granular failure notification preferences instead.
    Require2fa string
    2FA required setting. useSystemSetting uses the site-wide setting, including SSO exemptions. alwaysRequire and neverRequire override the site-wide setting when user-level overrides are allowed.
    RequireLoginBy string
    Require user to login by specified date otherwise it will be disabled.
    RequirePasswordChange bool
    Is a password change required upon next user login?
    ResponsibleGroupId int
    ID of the internal Group responsible for this Partner User, overriding the Partner default.
    ResponsibleUserId int
    ID of the internal User responsible for this Partner User, overriding the Partner default.
    RestapiPermission bool
    Can this user access the Web app, Desktop app, SDKs, or REST API? (All of these tools use the API internally, so this is one unified permission set.)
    SelfManaged bool
    Does this user manage it's own credentials or is it a shared/bot user?
    SftpPermission bool
    Can the user access with SFTP?
    SiteAdmin bool
    Is the user an administrator for this site?
    SiteId int
    Site ID
    SkipWelcomeScreen bool
    Skip Welcome page in the UI?
    SslRequired string
    SSL required setting
    SsoStrategyId int
    SSO (Single Sign On) strategy ID for the user, if applicable.
    SubscribeToNewsletter bool
    Is the user subscribed to the newsletter?
    Tags string
    Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    TimeZone string
    User time zone
    TypeOf2fa string
    Type(s) of 2FA methods in use, for programmatic use. Will be either sms, totp, webauthn, yubi, email, or multiple values sorted alphabetically and joined by an underscore. Does not specify whether user has more than one of a given method.
    TypeOf2faForDisplay string
    Type(s) of 2FA methods in use, formatted for displaying in the UI. Unlike typeOf2fa, this value will make clear when a user has more than 1 of the same type of method.
    UserHome string
    Home folder for FTP/SFTP. For users with the partnerRoot filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
    UserRoot string
    If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteRoot or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partnerRoot layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
    Username string
    User's username
    WorkspaceAdmin bool
    Is the user a Workspace administrator? Applicable only to the workspace ID related to this user, if one is set.
    WorkspaceId int
    Workspace ID
    active2fa bool
    Is 2fa active for the user?
    admin_group_ids list(number)
    List of group IDs of which this user is an administrator
    ai_assistant_personality_id number
    AI Assistant Personality ID assigned directly to this user, if any.
    allowed_ips string
    A list of allowed IPs if applicable. Newline delimited
    announcements_read bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Signifies that the user has read all the announcements in the UI.
    api_keys_count number
    Number of API keys associated with this user
    attachments_permission bool
    If true, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
    authenticate_until string
    Scheduled Date/Time at which user will be deactivated
    authentication_method string
    How is this user authenticated?
    avatar_delete bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, the avatar will be deleted.
    avatar_url string
    URL holding the user's avatar
    billable bool
    Is this a billable user record?
    billing_permission bool
    Allow this user to perform operations on the account, payments, and invoices?
    bypass_site_allowed_ips bool
    Allow this user to skip site-wide IP blacklists?
    bypass_user_lifecycle_rules bool
    Exempt this user from user lifecycle rules?
    change_password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Used for changing a password on an existing user.
    change_password_confirmation string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in changePassword.
    company string
    User's company
    created_at string
    When this user was created
    dav_permission bool
    Can the user connect with WebDAV?
    days_remaining_until_password_expire number
    Number of days remaining until password expires
    default_workspace_id number
    Workspace ID the user should land in by default when more than one Workspace is available.
    desktop_configuration_profile_id number
    Desktop Configuration Profile ID assigned directly to this user, if any.
    disabled bool
    Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
    disabled_expired_or_inactive bool
    Computed property that returns true if user disabled or expired or inactive.
    email string
    User email address
    externally_managed bool
    Is this user managed by a SsoStrategy?
    filesystem_layout string
    File system layout
    first_login_at string
    User's first login time
    ftp_permission bool
    Can the user access with FTP/FTPS?
    grant_permission string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Permission to grant on the User Root upon user creation. Can be blank or full, read, write, list, read+write, or list+write
    group_id number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Group ID to associate this user with.
    group_ids string
    Comma-separated list of group IDs of which this user is a member
    header_text string
    Text to display to the user in the header of the UI
    imported_password_hash string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
    integration_centric_profile_id number
    Integration Centric Profile ID assigned directly to this user, if any.
    language string
    Preferred language
    last_active_at string
    User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation
    last_api_use_at string
    User's most recent API use time
    last_dav_login_at string
    User's most recent login time via WebDAV
    last_desktop_login_at string
    User's most recent login time via Desktop app
    last_ftp_login_at string
    User's most recent login time via FTP
    last_login_at string
    User's most recent login time via any protocol
    last_protocol_cipher string
    The most recent protocol and cipher used
    last_restapi_login_at string
    User's most recent login time via Rest API
    last_sftp_login_at string
    User's most recent login time via SFTP
    last_web_login_at string
    User's most recent login time via web
    lockout_expires string
    Time in the future that the user will no longer be locked out if applicable
    name string
    User's full name
    notes string
    Any internal notes on the user
    notification_daily_send_time number
    Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
    notify_on_all_automation_failures bool
    Should the user receive automation failures via email?
    notify_on_all_expectation_failures bool
    Should the user receive expectation failures and misses via email?
    notify_on_all_pending_work_failures bool
    Should the user receive pending work failures via email?
    notify_on_all_siem_http_destination_failures bool
    Should the user receive siem failures via email?
    notify_on_all_site_warnings bool
    Should the user receive site warnings via email?
    notify_on_all_sso_failures bool
    Should the user receive sso/scim/ldap configuration/sync failures via email?
    notify_on_all_sync_failures bool
    Should the user receive sync failures via email?
    notify_on_all_user_security_events bool
    Should the user receive user security events via email?
    office_integration_enabled bool
    Enable integration with Office for the web?
    partner_admin bool
    Is this user a Partner administrator?
    partner_id number
    Partner ID if this user belongs to a Partner
    partner_name string
    Name of the Partner if this user belongs to a Partner
    password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User password.
    password_confirmation string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in password.
    password_expire_at string
    Password expiration datetime
    password_expired bool
    Is user's password expired?
    password_set_at string
    Last time the user's password was set
    password_validity_days number
    Number of days to allow user to use the same password
    primary_group_id number
    Primary group ID for Group Admin scoping
    public_keys_count number
    Number of public keys associated with this user
    readonly_site_admin bool
    Is the user an allowed to view all (non-billing) site configuration for this site?
    receive_admin_alerts bool
    Deprecated. Use notifyOnAllSiteWarnings and granular failure notification preferences instead.
    require2fa string
    2FA required setting. useSystemSetting uses the site-wide setting, including SSO exemptions. alwaysRequire and neverRequire override the site-wide setting when user-level overrides are allowed.
    require_login_by string
    Require user to login by specified date otherwise it will be disabled.
    require_password_change bool
    Is a password change required upon next user login?
    responsible_group_id number
    ID of the internal Group responsible for this Partner User, overriding the Partner default.
    responsible_user_id number
    ID of the internal User responsible for this Partner User, overriding the Partner default.
    restapi_permission bool
    Can this user access the Web app, Desktop app, SDKs, or REST API? (All of these tools use the API internally, so this is one unified permission set.)
    self_managed bool
    Does this user manage it's own credentials or is it a shared/bot user?
    sftp_permission bool
    Can the user access with SFTP?
    site_admin bool
    Is the user an administrator for this site?
    site_id number
    Site ID
    skip_welcome_screen bool
    Skip Welcome page in the UI?
    ssl_required string
    SSL required setting
    sso_strategy_id number
    SSO (Single Sign On) strategy ID for the user, if applicable.
    subscribe_to_newsletter bool
    Is the user subscribed to the newsletter?
    tags string
    Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    time_zone string
    User time zone
    type_of2fa string
    Type(s) of 2FA methods in use, for programmatic use. Will be either sms, totp, webauthn, yubi, email, or multiple values sorted alphabetically and joined by an underscore. Does not specify whether user has more than one of a given method.
    type_of2fa_for_display string
    Type(s) of 2FA methods in use, formatted for displaying in the UI. Unlike typeOf2fa, this value will make clear when a user has more than 1 of the same type of method.
    user_home string
    Home folder for FTP/SFTP. For users with the partnerRoot filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
    user_root string
    If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteRoot or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partnerRoot layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
    username string
    User's username
    workspace_admin bool
    Is the user a Workspace administrator? Applicable only to the workspace ID related to this user, if one is set.
    workspace_id number
    Workspace ID
    active2fa Boolean
    Is 2fa active for the user?
    adminGroupIds List<Integer>
    List of group IDs of which this user is an administrator
    aiAssistantPersonalityId Integer
    AI Assistant Personality ID assigned directly to this user, if any.
    allowedIps String
    A list of allowed IPs if applicable. Newline delimited
    announcementsRead Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Signifies that the user has read all the announcements in the UI.
    apiKeysCount Integer
    Number of API keys associated with this user
    attachmentsPermission Boolean
    If true, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
    authenticateUntil String
    Scheduled Date/Time at which user will be deactivated
    authenticationMethod String
    How is this user authenticated?
    avatarDelete Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, the avatar will be deleted.
    avatarUrl String
    URL holding the user's avatar
    billable Boolean
    Is this a billable user record?
    billingPermission Boolean
    Allow this user to perform operations on the account, payments, and invoices?
    bypassSiteAllowedIps Boolean
    Allow this user to skip site-wide IP blacklists?
    bypassUserLifecycleRules Boolean
    Exempt this user from user lifecycle rules?
    changePassword String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Used for changing a password on an existing user.
    changePasswordConfirmation String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in changePassword.
    company String
    User's company
    createdAt String
    When this user was created
    davPermission Boolean
    Can the user connect with WebDAV?
    daysRemainingUntilPasswordExpire Integer
    Number of days remaining until password expires
    defaultWorkspaceId Integer
    Workspace ID the user should land in by default when more than one Workspace is available.
    desktopConfigurationProfileId Integer
    Desktop Configuration Profile ID assigned directly to this user, if any.
    disabled Boolean
    Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
    disabledExpiredOrInactive Boolean
    Computed property that returns true if user disabled or expired or inactive.
    email String
    User email address
    externallyManaged Boolean
    Is this user managed by a SsoStrategy?
    filesystemLayout String
    File system layout
    firstLoginAt String
    User's first login time
    ftpPermission Boolean
    Can the user access with FTP/FTPS?
    grantPermission String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Permission to grant on the User Root upon user creation. Can be blank or full, read, write, list, read+write, or list+write
    groupId Integer
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Group ID to associate this user with.
    groupIds String
    Comma-separated list of group IDs of which this user is a member
    headerText String
    Text to display to the user in the header of the UI
    importedPasswordHash String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
    integrationCentricProfileId Integer
    Integration Centric Profile ID assigned directly to this user, if any.
    language String
    Preferred language
    lastActiveAt String
    User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation
    lastApiUseAt String
    User's most recent API use time
    lastDavLoginAt String
    User's most recent login time via WebDAV
    lastDesktopLoginAt String
    User's most recent login time via Desktop app
    lastFtpLoginAt String
    User's most recent login time via FTP
    lastLoginAt String
    User's most recent login time via any protocol
    lastProtocolCipher String
    The most recent protocol and cipher used
    lastRestapiLoginAt String
    User's most recent login time via Rest API
    lastSftpLoginAt String
    User's most recent login time via SFTP
    lastWebLoginAt String
    User's most recent login time via web
    lockoutExpires String
    Time in the future that the user will no longer be locked out if applicable
    name String
    User's full name
    notes String
    Any internal notes on the user
    notificationDailySendTime Integer
    Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
    notifyOnAllAutomationFailures Boolean
    Should the user receive automation failures via email?
    notifyOnAllExpectationFailures Boolean
    Should the user receive expectation failures and misses via email?
    notifyOnAllPendingWorkFailures Boolean
    Should the user receive pending work failures via email?
    notifyOnAllSiemHttpDestinationFailures Boolean
    Should the user receive siem failures via email?
    notifyOnAllSiteWarnings Boolean
    Should the user receive site warnings via email?
    notifyOnAllSsoFailures Boolean
    Should the user receive sso/scim/ldap configuration/sync failures via email?
    notifyOnAllSyncFailures Boolean
    Should the user receive sync failures via email?
    notifyOnAllUserSecurityEvents Boolean
    Should the user receive user security events via email?
    officeIntegrationEnabled Boolean
    Enable integration with Office for the web?
    partnerAdmin Boolean
    Is this user a Partner administrator?
    partnerId Integer
    Partner ID if this user belongs to a Partner
    partnerName String
    Name of the Partner if this user belongs to a Partner
    password String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User password.
    passwordConfirmation String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in password.
    passwordExpireAt String
    Password expiration datetime
    passwordExpired Boolean
    Is user's password expired?
    passwordSetAt String
    Last time the user's password was set
    passwordValidityDays Integer
    Number of days to allow user to use the same password
    primaryGroupId Integer
    Primary group ID for Group Admin scoping
    publicKeysCount Integer
    Number of public keys associated with this user
    readonlySiteAdmin Boolean
    Is the user an allowed to view all (non-billing) site configuration for this site?
    receiveAdminAlerts Boolean
    Deprecated. Use notifyOnAllSiteWarnings and granular failure notification preferences instead.
    require2fa String
    2FA required setting. useSystemSetting uses the site-wide setting, including SSO exemptions. alwaysRequire and neverRequire override the site-wide setting when user-level overrides are allowed.
    requireLoginBy String
    Require user to login by specified date otherwise it will be disabled.
    requirePasswordChange Boolean
    Is a password change required upon next user login?
    responsibleGroupId Integer
    ID of the internal Group responsible for this Partner User, overriding the Partner default.
    responsibleUserId Integer
    ID of the internal User responsible for this Partner User, overriding the Partner default.
    restapiPermission Boolean
    Can this user access the Web app, Desktop app, SDKs, or REST API? (All of these tools use the API internally, so this is one unified permission set.)
    selfManaged Boolean
    Does this user manage it's own credentials or is it a shared/bot user?
    sftpPermission Boolean
    Can the user access with SFTP?
    siteAdmin Boolean
    Is the user an administrator for this site?
    siteId Integer
    Site ID
    skipWelcomeScreen Boolean
    Skip Welcome page in the UI?
    sslRequired String
    SSL required setting
    ssoStrategyId Integer
    SSO (Single Sign On) strategy ID for the user, if applicable.
    subscribeToNewsletter Boolean
    Is the user subscribed to the newsletter?
    tags String
    Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    timeZone String
    User time zone
    typeOf2fa String
    Type(s) of 2FA methods in use, for programmatic use. Will be either sms, totp, webauthn, yubi, email, or multiple values sorted alphabetically and joined by an underscore. Does not specify whether user has more than one of a given method.
    typeOf2faForDisplay String
    Type(s) of 2FA methods in use, formatted for displaying in the UI. Unlike typeOf2fa, this value will make clear when a user has more than 1 of the same type of method.
    userHome String
    Home folder for FTP/SFTP. For users with the partnerRoot filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
    userRoot String
    If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteRoot or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partnerRoot layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
    username String
    User's username
    workspaceAdmin Boolean
    Is the user a Workspace administrator? Applicable only to the workspace ID related to this user, if one is set.
    workspaceId Integer
    Workspace ID
    active2fa boolean
    Is 2fa active for the user?
    adminGroupIds number[]
    List of group IDs of which this user is an administrator
    aiAssistantPersonalityId number
    AI Assistant Personality ID assigned directly to this user, if any.
    allowedIps string
    A list of allowed IPs if applicable. Newline delimited
    announcementsRead boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Signifies that the user has read all the announcements in the UI.
    apiKeysCount number
    Number of API keys associated with this user
    attachmentsPermission boolean
    If true, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
    authenticateUntil string
    Scheduled Date/Time at which user will be deactivated
    authenticationMethod string
    How is this user authenticated?
    avatarDelete boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, the avatar will be deleted.
    avatarUrl string
    URL holding the user's avatar
    billable boolean
    Is this a billable user record?
    billingPermission boolean
    Allow this user to perform operations on the account, payments, and invoices?
    bypassSiteAllowedIps boolean
    Allow this user to skip site-wide IP blacklists?
    bypassUserLifecycleRules boolean
    Exempt this user from user lifecycle rules?
    changePassword string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Used for changing a password on an existing user.
    changePasswordConfirmation string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in changePassword.
    company string
    User's company
    createdAt string
    When this user was created
    davPermission boolean
    Can the user connect with WebDAV?
    daysRemainingUntilPasswordExpire number
    Number of days remaining until password expires
    defaultWorkspaceId number
    Workspace ID the user should land in by default when more than one Workspace is available.
    desktopConfigurationProfileId number
    Desktop Configuration Profile ID assigned directly to this user, if any.
    disabled boolean
    Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
    disabledExpiredOrInactive boolean
    Computed property that returns true if user disabled or expired or inactive.
    email string
    User email address
    externallyManaged boolean
    Is this user managed by a SsoStrategy?
    filesystemLayout string
    File system layout
    firstLoginAt string
    User's first login time
    ftpPermission boolean
    Can the user access with FTP/FTPS?
    grantPermission string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Permission to grant on the User Root upon user creation. Can be blank or full, read, write, list, read+write, or list+write
    groupId number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Group ID to associate this user with.
    groupIds string
    Comma-separated list of group IDs of which this user is a member
    headerText string
    Text to display to the user in the header of the UI
    importedPasswordHash string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
    integrationCentricProfileId number
    Integration Centric Profile ID assigned directly to this user, if any.
    language string
    Preferred language
    lastActiveAt string
    User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation
    lastApiUseAt string
    User's most recent API use time
    lastDavLoginAt string
    User's most recent login time via WebDAV
    lastDesktopLoginAt string
    User's most recent login time via Desktop app
    lastFtpLoginAt string
    User's most recent login time via FTP
    lastLoginAt string
    User's most recent login time via any protocol
    lastProtocolCipher string
    The most recent protocol and cipher used
    lastRestapiLoginAt string
    User's most recent login time via Rest API
    lastSftpLoginAt string
    User's most recent login time via SFTP
    lastWebLoginAt string
    User's most recent login time via web
    lockoutExpires string
    Time in the future that the user will no longer be locked out if applicable
    name string
    User's full name
    notes string
    Any internal notes on the user
    notificationDailySendTime number
    Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
    notifyOnAllAutomationFailures boolean
    Should the user receive automation failures via email?
    notifyOnAllExpectationFailures boolean
    Should the user receive expectation failures and misses via email?
    notifyOnAllPendingWorkFailures boolean
    Should the user receive pending work failures via email?
    notifyOnAllSiemHttpDestinationFailures boolean
    Should the user receive siem failures via email?
    notifyOnAllSiteWarnings boolean
    Should the user receive site warnings via email?
    notifyOnAllSsoFailures boolean
    Should the user receive sso/scim/ldap configuration/sync failures via email?
    notifyOnAllSyncFailures boolean
    Should the user receive sync failures via email?
    notifyOnAllUserSecurityEvents boolean
    Should the user receive user security events via email?
    officeIntegrationEnabled boolean
    Enable integration with Office for the web?
    partnerAdmin boolean
    Is this user a Partner administrator?
    partnerId number
    Partner ID if this user belongs to a Partner
    partnerName string
    Name of the Partner if this user belongs to a Partner
    password string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User password.
    passwordConfirmation string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in password.
    passwordExpireAt string
    Password expiration datetime
    passwordExpired boolean
    Is user's password expired?
    passwordSetAt string
    Last time the user's password was set
    passwordValidityDays number
    Number of days to allow user to use the same password
    primaryGroupId number
    Primary group ID for Group Admin scoping
    publicKeysCount number
    Number of public keys associated with this user
    readonlySiteAdmin boolean
    Is the user an allowed to view all (non-billing) site configuration for this site?
    receiveAdminAlerts boolean
    Deprecated. Use notifyOnAllSiteWarnings and granular failure notification preferences instead.
    require2fa string
    2FA required setting. useSystemSetting uses the site-wide setting, including SSO exemptions. alwaysRequire and neverRequire override the site-wide setting when user-level overrides are allowed.
    requireLoginBy string
    Require user to login by specified date otherwise it will be disabled.
    requirePasswordChange boolean
    Is a password change required upon next user login?
    responsibleGroupId number
    ID of the internal Group responsible for this Partner User, overriding the Partner default.
    responsibleUserId number
    ID of the internal User responsible for this Partner User, overriding the Partner default.
    restapiPermission boolean
    Can this user access the Web app, Desktop app, SDKs, or REST API? (All of these tools use the API internally, so this is one unified permission set.)
    selfManaged boolean
    Does this user manage it's own credentials or is it a shared/bot user?
    sftpPermission boolean
    Can the user access with SFTP?
    siteAdmin boolean
    Is the user an administrator for this site?
    siteId number
    Site ID
    skipWelcomeScreen boolean
    Skip Welcome page in the UI?
    sslRequired string
    SSL required setting
    ssoStrategyId number
    SSO (Single Sign On) strategy ID for the user, if applicable.
    subscribeToNewsletter boolean
    Is the user subscribed to the newsletter?
    tags string
    Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    timeZone string
    User time zone
    typeOf2fa string
    Type(s) of 2FA methods in use, for programmatic use. Will be either sms, totp, webauthn, yubi, email, or multiple values sorted alphabetically and joined by an underscore. Does not specify whether user has more than one of a given method.
    typeOf2faForDisplay string
    Type(s) of 2FA methods in use, formatted for displaying in the UI. Unlike typeOf2fa, this value will make clear when a user has more than 1 of the same type of method.
    userHome string
    Home folder for FTP/SFTP. For users with the partnerRoot filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
    userRoot string
    If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteRoot or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partnerRoot layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
    username string
    User's username
    workspaceAdmin boolean
    Is the user a Workspace administrator? Applicable only to the workspace ID related to this user, if one is set.
    workspaceId number
    Workspace ID
    active2fa bool
    Is 2fa active for the user?
    admin_group_ids Sequence[int]
    List of group IDs of which this user is an administrator
    ai_assistant_personality_id int
    AI Assistant Personality ID assigned directly to this user, if any.
    allowed_ips str
    A list of allowed IPs if applicable. Newline delimited
    announcements_read bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Signifies that the user has read all the announcements in the UI.
    api_keys_count int
    Number of API keys associated with this user
    attachments_permission bool
    If true, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
    authenticate_until str
    Scheduled Date/Time at which user will be deactivated
    authentication_method str
    How is this user authenticated?
    avatar_delete bool
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, the avatar will be deleted.
    avatar_url str
    URL holding the user's avatar
    billable bool
    Is this a billable user record?
    billing_permission bool
    Allow this user to perform operations on the account, payments, and invoices?
    bypass_site_allowed_ips bool
    Allow this user to skip site-wide IP blacklists?
    bypass_user_lifecycle_rules bool
    Exempt this user from user lifecycle rules?
    change_password str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Used for changing a password on an existing user.
    change_password_confirmation str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in changePassword.
    company str
    User's company
    created_at str
    When this user was created
    dav_permission bool
    Can the user connect with WebDAV?
    days_remaining_until_password_expire int
    Number of days remaining until password expires
    default_workspace_id int
    Workspace ID the user should land in by default when more than one Workspace is available.
    desktop_configuration_profile_id int
    Desktop Configuration Profile ID assigned directly to this user, if any.
    disabled bool
    Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
    disabled_expired_or_inactive bool
    Computed property that returns true if user disabled or expired or inactive.
    email str
    User email address
    externally_managed bool
    Is this user managed by a SsoStrategy?
    filesystem_layout str
    File system layout
    first_login_at str
    User's first login time
    ftp_permission bool
    Can the user access with FTP/FTPS?
    grant_permission str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Permission to grant on the User Root upon user creation. Can be blank or full, read, write, list, read+write, or list+write
    group_id int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Group ID to associate this user with.
    group_ids str
    Comma-separated list of group IDs of which this user is a member
    header_text str
    Text to display to the user in the header of the UI
    imported_password_hash str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
    integration_centric_profile_id int
    Integration Centric Profile ID assigned directly to this user, if any.
    language str
    Preferred language
    last_active_at str
    User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation
    last_api_use_at str
    User's most recent API use time
    last_dav_login_at str
    User's most recent login time via WebDAV
    last_desktop_login_at str
    User's most recent login time via Desktop app
    last_ftp_login_at str
    User's most recent login time via FTP
    last_login_at str
    User's most recent login time via any protocol
    last_protocol_cipher str
    The most recent protocol and cipher used
    last_restapi_login_at str
    User's most recent login time via Rest API
    last_sftp_login_at str
    User's most recent login time via SFTP
    last_web_login_at str
    User's most recent login time via web
    lockout_expires str
    Time in the future that the user will no longer be locked out if applicable
    name str
    User's full name
    notes str
    Any internal notes on the user
    notification_daily_send_time int
    Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
    notify_on_all_automation_failures bool
    Should the user receive automation failures via email?
    notify_on_all_expectation_failures bool
    Should the user receive expectation failures and misses via email?
    notify_on_all_pending_work_failures bool
    Should the user receive pending work failures via email?
    notify_on_all_siem_http_destination_failures bool
    Should the user receive siem failures via email?
    notify_on_all_site_warnings bool
    Should the user receive site warnings via email?
    notify_on_all_sso_failures bool
    Should the user receive sso/scim/ldap configuration/sync failures via email?
    notify_on_all_sync_failures bool
    Should the user receive sync failures via email?
    notify_on_all_user_security_events bool
    Should the user receive user security events via email?
    office_integration_enabled bool
    Enable integration with Office for the web?
    partner_admin bool
    Is this user a Partner administrator?
    partner_id int
    Partner ID if this user belongs to a Partner
    partner_name str
    Name of the Partner if this user belongs to a Partner
    password str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User password.
    password_confirmation str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in password.
    password_expire_at str
    Password expiration datetime
    password_expired bool
    Is user's password expired?
    password_set_at str
    Last time the user's password was set
    password_validity_days int
    Number of days to allow user to use the same password
    primary_group_id int
    Primary group ID for Group Admin scoping
    public_keys_count int
    Number of public keys associated with this user
    readonly_site_admin bool
    Is the user an allowed to view all (non-billing) site configuration for this site?
    receive_admin_alerts bool
    Deprecated. Use notifyOnAllSiteWarnings and granular failure notification preferences instead.
    require2fa str
    2FA required setting. useSystemSetting uses the site-wide setting, including SSO exemptions. alwaysRequire and neverRequire override the site-wide setting when user-level overrides are allowed.
    require_login_by str
    Require user to login by specified date otherwise it will be disabled.
    require_password_change bool
    Is a password change required upon next user login?
    responsible_group_id int
    ID of the internal Group responsible for this Partner User, overriding the Partner default.
    responsible_user_id int
    ID of the internal User responsible for this Partner User, overriding the Partner default.
    restapi_permission bool
    Can this user access the Web app, Desktop app, SDKs, or REST API? (All of these tools use the API internally, so this is one unified permission set.)
    self_managed bool
    Does this user manage it's own credentials or is it a shared/bot user?
    sftp_permission bool
    Can the user access with SFTP?
    site_admin bool
    Is the user an administrator for this site?
    site_id int
    Site ID
    skip_welcome_screen bool
    Skip Welcome page in the UI?
    ssl_required str
    SSL required setting
    sso_strategy_id int
    SSO (Single Sign On) strategy ID for the user, if applicable.
    subscribe_to_newsletter bool
    Is the user subscribed to the newsletter?
    tags str
    Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    time_zone str
    User time zone
    type_of2fa str
    Type(s) of 2FA methods in use, for programmatic use. Will be either sms, totp, webauthn, yubi, email, or multiple values sorted alphabetically and joined by an underscore. Does not specify whether user has more than one of a given method.
    type_of2fa_for_display str
    Type(s) of 2FA methods in use, formatted for displaying in the UI. Unlike typeOf2fa, this value will make clear when a user has more than 1 of the same type of method.
    user_home str
    Home folder for FTP/SFTP. For users with the partnerRoot filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
    user_root str
    If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteRoot or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partnerRoot layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
    username str
    User's username
    workspace_admin bool
    Is the user a Workspace administrator? Applicable only to the workspace ID related to this user, if one is set.
    workspace_id int
    Workspace ID
    active2fa Boolean
    Is 2fa active for the user?
    adminGroupIds List<Number>
    List of group IDs of which this user is an administrator
    aiAssistantPersonalityId Number
    AI Assistant Personality ID assigned directly to this user, if any.
    allowedIps String
    A list of allowed IPs if applicable. Newline delimited
    announcementsRead Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Signifies that the user has read all the announcements in the UI.
    apiKeysCount Number
    Number of API keys associated with this user
    attachmentsPermission Boolean
    If true, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
    authenticateUntil String
    Scheduled Date/Time at which user will be deactivated
    authenticationMethod String
    How is this user authenticated?
    avatarDelete Boolean
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. If true, the avatar will be deleted.
    avatarUrl String
    URL holding the user's avatar
    billable Boolean
    Is this a billable user record?
    billingPermission Boolean
    Allow this user to perform operations on the account, payments, and invoices?
    bypassSiteAllowedIps Boolean
    Allow this user to skip site-wide IP blacklists?
    bypassUserLifecycleRules Boolean
    Exempt this user from user lifecycle rules?
    changePassword String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Used for changing a password on an existing user.
    changePasswordConfirmation String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in changePassword.
    company String
    User's company
    createdAt String
    When this user was created
    davPermission Boolean
    Can the user connect with WebDAV?
    daysRemainingUntilPasswordExpire Number
    Number of days remaining until password expires
    defaultWorkspaceId Number
    Workspace ID the user should land in by default when more than one Workspace is available.
    desktopConfigurationProfileId Number
    Desktop Configuration Profile ID assigned directly to this user, if any.
    disabled Boolean
    Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
    disabledExpiredOrInactive Boolean
    Computed property that returns true if user disabled or expired or inactive.
    email String
    User email address
    externallyManaged Boolean
    Is this user managed by a SsoStrategy?
    filesystemLayout String
    File system layout
    firstLoginAt String
    User's first login time
    ftpPermission Boolean
    Can the user access with FTP/FTPS?
    grantPermission String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Permission to grant on the User Root upon user creation. Can be blank or full, read, write, list, read+write, or list+write
    groupId Number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Group ID to associate this user with.
    groupIds String
    Comma-separated list of group IDs of which this user is a member
    headerText String
    Text to display to the user in the header of the UI
    importedPasswordHash String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
    integrationCentricProfileId Number
    Integration Centric Profile ID assigned directly to this user, if any.
    language String
    Preferred language
    lastActiveAt String
    User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation
    lastApiUseAt String
    User's most recent API use time
    lastDavLoginAt String
    User's most recent login time via WebDAV
    lastDesktopLoginAt String
    User's most recent login time via Desktop app
    lastFtpLoginAt String
    User's most recent login time via FTP
    lastLoginAt String
    User's most recent login time via any protocol
    lastProtocolCipher String
    The most recent protocol and cipher used
    lastRestapiLoginAt String
    User's most recent login time via Rest API
    lastSftpLoginAt String
    User's most recent login time via SFTP
    lastWebLoginAt String
    User's most recent login time via web
    lockoutExpires String
    Time in the future that the user will no longer be locked out if applicable
    name String
    User's full name
    notes String
    Any internal notes on the user
    notificationDailySendTime Number
    Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
    notifyOnAllAutomationFailures Boolean
    Should the user receive automation failures via email?
    notifyOnAllExpectationFailures Boolean
    Should the user receive expectation failures and misses via email?
    notifyOnAllPendingWorkFailures Boolean
    Should the user receive pending work failures via email?
    notifyOnAllSiemHttpDestinationFailures Boolean
    Should the user receive siem failures via email?
    notifyOnAllSiteWarnings Boolean
    Should the user receive site warnings via email?
    notifyOnAllSsoFailures Boolean
    Should the user receive sso/scim/ldap configuration/sync failures via email?
    notifyOnAllSyncFailures Boolean
    Should the user receive sync failures via email?
    notifyOnAllUserSecurityEvents Boolean
    Should the user receive user security events via email?
    officeIntegrationEnabled Boolean
    Enable integration with Office for the web?
    partnerAdmin Boolean
    Is this user a Partner administrator?
    partnerId Number
    Partner ID if this user belongs to a Partner
    partnerName String
    Name of the Partner if this user belongs to a Partner
    password String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User password.
    passwordConfirmation String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Optional, but if provided, we will ensure that it matches the value sent in password.
    passwordExpireAt String
    Password expiration datetime
    passwordExpired Boolean
    Is user's password expired?
    passwordSetAt String
    Last time the user's password was set
    passwordValidityDays Number
    Number of days to allow user to use the same password
    primaryGroupId Number
    Primary group ID for Group Admin scoping
    publicKeysCount Number
    Number of public keys associated with this user
    readonlySiteAdmin Boolean
    Is the user an allowed to view all (non-billing) site configuration for this site?
    receiveAdminAlerts Boolean
    Deprecated. Use notifyOnAllSiteWarnings and granular failure notification preferences instead.
    require2fa String
    2FA required setting. useSystemSetting uses the site-wide setting, including SSO exemptions. alwaysRequire and neverRequire override the site-wide setting when user-level overrides are allowed.
    requireLoginBy String
    Require user to login by specified date otherwise it will be disabled.
    requirePasswordChange Boolean
    Is a password change required upon next user login?
    responsibleGroupId Number
    ID of the internal Group responsible for this Partner User, overriding the Partner default.
    responsibleUserId Number
    ID of the internal User responsible for this Partner User, overriding the Partner default.
    restapiPermission Boolean
    Can this user access the Web app, Desktop app, SDKs, or REST API? (All of these tools use the API internally, so this is one unified permission set.)
    selfManaged Boolean
    Does this user manage it's own credentials or is it a shared/bot user?
    sftpPermission Boolean
    Can the user access with SFTP?
    siteAdmin Boolean
    Is the user an administrator for this site?
    siteId Number
    Site ID
    skipWelcomeScreen Boolean
    Skip Welcome page in the UI?
    sslRequired String
    SSL required setting
    ssoStrategyId Number
    SSO (Single Sign On) strategy ID for the user, if applicable.
    subscribeToNewsletter Boolean
    Is the user subscribed to the newsletter?
    tags String
    Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    timeZone String
    User time zone
    typeOf2fa String
    Type(s) of 2FA methods in use, for programmatic use. Will be either sms, totp, webauthn, yubi, email, or multiple values sorted alphabetically and joined by an underscore. Does not specify whether user has more than one of a given method.
    typeOf2faForDisplay String
    Type(s) of 2FA methods in use, formatted for displaying in the UI. Unlike typeOf2fa, this value will make clear when a user has more than 1 of the same type of method.
    userHome String
    Home folder for FTP/SFTP. For users with the partnerRoot filesystem layout, this path is relative to the Partner root folder. In all other cases, it is an absolute path. Only applies to FTP and SFTP, and not any other interface.
    userRoot String
    If filesystem layout is user_root, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteRoot or partner_root, this acts as a root folder only for FTP and SFTP (SFTP applicability also requires a site-wide setting to be set). For partnerRoot layout, this path is relative to the Partner root folder for all callers and blank opts out of an additional protocol root. In this situation, this path is not applied to the API, Desktop, or Web interface.
    username String
    User's username
    workspaceAdmin Boolean
    Is the user a Workspace administrator? Applicable only to the workspace ID related to this user, if one is set.
    workspaceId Number
    Workspace ID

    Import

    The pulumi import command can be used, for example:

    Users can be imported by specifying the id.

    $ pulumi import filescom:index/user:User example_user 1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    filescom jschady/pulumi-filescom
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the filescom Terraform Provider.
    filescom logo
    Viewing docs for Files.com v0.1.1
    published on Thursday, Aug 20, 2026 by jschady
    Schema (JSON)
    jschady/pulumi-filescom

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial