getUser

Files.com v0.1.1, Aug 20 26

Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

Schema (JSON)

jschady/pulumi-filescom

Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

Schema (JSON)

jschady/pulumi-filescom

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 = filescom.getUser({
    id: 1,
});

import pulumi
import pulumi_filescom as filescom

example_user = filescom.get_user(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.GetUser(ctx, &filescom.LookupUserArgs{
			Id: 1,
		}, nil)
		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 = Filescom.GetUser.Invoke(new()
    {
        Id = 1,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.FilescomFunctions;
import com.pulumi.filescom.inputs.GetUserArgs;
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) {
        final var exampleUser = FilescomFunctions.getUser(GetUserArgs.builder()
            .id(1)
            .build());

    }
}

variables:
  exampleUser:
    fn::invoke:
      function: filescom:getUser
      arguments:
        id: 1

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

data "filescom_getuser" "exampleUser" {
  id = 1
}

Using getUser

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getUser(args: GetUserArgs, opts?: InvokeOptions): Promise<GetUserResult>
function getUserOutput(args: GetUserOutputArgs, opts?: InvokeOutputOptions): Output<GetUserResult>

def get_user(id: Optional[int] = None,
             opts: Optional[InvokeOptions] = None) -> GetUserResult
def get_user_output(id: pulumi.Input[Optional[int]] = None,
             opts: Optional[InvokeOutputOptions] = None) -> Output[GetUserResult]

func LookupUser(ctx *Context, args *LookupUserArgs, opts ...InvokeOption) (*LookupUserResult, error)
func LookupUserOutput(ctx *Context, args *LookupUserOutputArgs, opts ...InvokeOption) LookupUserResultOutput

> Note: This function is named LookupUser in the Go SDK.

public static class GetUser 
{
    public static Task<GetUserResult> InvokeAsync(GetUserArgs args, InvokeOptions? opts = null)
    public static Output<GetUserResult> Invoke(GetUserInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetUserResult> Invoke(GetUserInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
public static Output<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
public static Output<GetUserResult> getUser(GetUserArgs args, InvokeOutputOptions options)

fn::invoke:
  function: filescom:index/getUser:getUser
  arguments:
    # arguments dictionary

data "filescom_get_user" "name" {
    # arguments
}

The following arguments are supported:

Id int: User ID

Id int: User ID

id number: User ID

id Integer: User ID

id number: User ID

id int: User ID

id Number: User ID

getUser Result

The following output properties are available:

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
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?
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?
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?
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
Id int: User ID
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
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 userroot, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteroot or partnerroot, 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
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?
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?
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?
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
Id int: User ID
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
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 userroot, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteroot or partnerroot, 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
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_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?
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?
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
id number: User ID
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_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 userroot, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteroot or partnerroot, 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
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?
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?
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?
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
id Integer: User ID
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
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 userroot, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteroot or partnerroot, 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
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?
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?
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?
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
id number: User ID
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
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 userroot, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteroot or partnerroot, 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
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_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?
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?
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
id int: User ID
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_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 userroot, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteroot or partnerroot, 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
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?
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?
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?
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
id Number: User ID
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
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 userroot, this path is the root path the user is fixed to for all interfaces. If the filesystem layout is siteroot or partnerroot, 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

Package Details

Repository: filescom jschady/pulumi-filescom
License: Apache-2.0
Notes: This Pulumi package is based on the filescom Terraform Provider.

Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

Schema (JSON)

jschady/pulumi-filescom

filescom.getUser

On this page

On this page

Authentication

Example Usage

Using getUser

getUser Result

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

filescom.getUser

On this page

On this page

Authentication

Example Usage

Using getUser

getUser Result

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.