Show User

{
  "type": "object",
  "description": "Create User",
  "properties": {
    "active_2fa": {
      "type": "boolean",
      "description": "Is 2fa active for the user?"
    },
    "admin_group_ids": {
      "type": "array",
      "description": "List of group IDs of which this user is an administrator",
      "items": {
        "type": "integer",
        "format": "int32"
      }
    },
    "allowed_ips": {
      "type": "string",
      "description": "A list of allowed IPs if applicable.  Newline delimited"
    },
    "api_keys_count": {
      "type": "integer",
      "format": "int32",
      "description": "Number of api keys associated with this user"
    },
    "attachments_permission": {
      "type": "boolean",
      "description": "DEPRECATED: Can the user create Bundles (aka Share Links)? Use the bundle permission instead."
    },
    "authenticate_until": {
      "type": "string",
      "format": "date-time",
      "description": "Scheduled Date/Time at which user will be deactivated"
    },
    "authentication_method": {
      "type": "string",
      "description": "How is this user authenticated?",
      "enum": [
        "password",
        "unused_former_ldap",
        "sso",
        "none",
        "email_signup",
        "password_with_imported_hash"
      ]
    },
    "avatar_url": {
      "type": "string",
      "description": "URL holding the user's avatar"
    },
    "billing_permission": {
      "type": "boolean",
      "description": "Allow this user to perform operations on the account, payments, and invoices?"
    },
    "bypass_inactive_disable": {
      "type": "boolean",
      "description": "Exempt this user from being disabled based on inactivity?"
    },
    "bypass_site_allowed_ips": {
      "type": "boolean",
      "description": "Allow this user to skip site-wide IP blacklists?"
    },
    "company": {
      "type": "string",
      "description": "User's company"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When this user was created"
    },
    "dav_permission": {
      "type": "boolean",
      "description": "Can the user connect with WebDAV?"
    },
    "days_remaining_until_password_expire": {
      "type": "integer",
      "format": "int32",
      "description": "Number of days remaining until password expires"
    },
    "disabled": {
      "type": "boolean",
      "description": "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."
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "User email address"
    },
    "externally_managed": {
      "type": "boolean",
      "description": "Is this user managed by a SsoStrategy?"
    },
    "first_login_at": {
      "type": "string",
      "format": "date-time",
      "description": "User's first login time"
    },
    "ftp_permission": {
      "type": "boolean",
      "description": "Can the user access with FTP/FTPS?"
    },
    "group_ids": {
      "type": "string",
      "description": "Comma-separated list of group IDs of which this user is a member"
    },
    "header_text": {
      "type": "string",
      "description": "Text to display to the user in the header of the UI"
    },
    "id": {
      "type": "integer",
      "format": "int32",
      "description": "User ID"
    },
    "language": {
      "type": "string",
      "description": "Preferred language"
    },
    "last_active_at": {
      "type": "string",
      "format": "date-time",
      "description": "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": {
      "type": "string",
      "format": "date-time",
      "description": "User's most recent API use time"
    },
    "last_dav_login_at": {
      "type": "string",
      "format": "date-time",
      "description": "User's most recent login time via WebDAV"
    },
    "last_desktop_login_at": {
      "type": "string",
      "format": "date-time",
      "description": "User's most recent login time via Desktop app"
    },
    "last_ftp_login_at": {
      "type": "string",
      "format": "date-time",
      "description": "User's most recent login time via FTP"
    },
    "last_login_at": {
      "type": "string",
      "format": "date-time",
      "description": "User's most recent login time via any protocol"
    },
    "last_protocol_cipher": {
      "type": "string",
      "description": "The most recent protocol and cipher used"
    },
    "last_restapi_login_at": {
      "type": "string",
      "format": "date-time",
      "description": "User's most recent login time via Rest API"
    },
    "last_sftp_login_at": {
      "type": "string",
      "format": "date-time",
      "description": "User's most recent login time via SFTP"
    },
    "last_web_login_at": {
      "type": "string",
      "format": "date-time",
      "description": "User's most recent login time via web"
    },
    "lockout_expires": {
      "type": "string",
      "format": "date-time",
      "description": "Time in the future that the user will no longer be locked out if applicable"
    },
    "name": {
      "type": "string",
      "description": "User's full name"
    },
    "notes": {
      "type": "string",
      "description": "Any internal notes on the user"
    },
    "notification_daily_send_time": {
      "type": "integer",
      "format": "int32",
      "description": "Hour of the day at which daily notifications should be sent. Can be in range 0 to 23"
    },
    "office_integration_enabled": {
      "type": "boolean",
      "description": "Enable integration with Office for the web?"
    },
    "password_expire_at": {
      "type": "string",
      "format": "date-time",
      "description": "Password expiration datetime"
    },
    "password_expired": {
      "type": "boolean",
      "description": "Is user's password expired?"
    },
    "password_set_at": {
      "type": "string",
      "format": "date-time",
      "description": "Last time the user's password was set"
    },
    "password_validity_days": {
      "type": "integer",
      "format": "int32",
      "description": "Number of days to allow user to use the same password"
    },
    "public_keys_count": {
      "type": "integer",
      "format": "int32",
      "description": "Number of public keys associated with this user"
    },
    "receive_admin_alerts": {
      "type": "boolean",
      "description": "Should the user receive admin alerts such a certificate expiration notifications and overages?"
    },
    "require_2fa": {
      "type": "string",
      "description": "2FA required setting",
      "enum": [
        "use_system_setting",
        "always_require",
        "never_require"
      ]
    },
    "require_password_change": {
      "type": "boolean",
      "description": "Is a password change required upon next user login?"
    },
    "restapi_permission": {
      "type": "boolean",
      "description": "Can this user access the REST API?"
    },
    "self_managed": {
      "type": "boolean",
      "description": "Does this user manage it's own credentials or is it a shared/bot user?"
    },
    "sftp_permission": {
      "type": "boolean",
      "description": "Can the user access with SFTP?"
    },
    "site_admin": {
      "type": "boolean",
      "description": "Is the user an administrator for this site?"
    },
    "skip_welcome_screen": {
      "type": "boolean",
      "description": "Skip Welcome page in the UI?"
    },
    "ssl_required": {
      "type": "string",
      "description": "SSL required setting",
      "enum": [
        "use_system_setting",
        "always_require",
        "never_require"
      ]
    },
    "sso_strategy_id": {
      "type": "integer",
      "format": "int32",
      "description": "SSO (Single Sign On) strategy ID for the user, if applicable."
    },
    "subscribe_to_newsletter": {
      "type": "boolean",
      "description": "Is the user subscribed to the newsletter?"
    },
    "time_zone": {
      "type": "string",
      "description": "User time zone"
    },
    "type_of_2fa": {
      "type": "string",
      "description": "Type(s) of 2FA methods in use.  Will be either `sms`, `totp`, `u2f`, `yubi`, or multiple values sorted alphabetically and joined by an underscore."
    },
    "user_root": {
      "type": "string",
      "description": "Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.)  Note that this is not used for API, Desktop, or Web interface."
    },
    "username": {
      "type": "string",
      "description": "User's username"
    }
  }
}