View Source

User ID object representing FTP-Stream User ID:

{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "login": "demo",
  "password": "demopassword",
  "real_name": "John Smith",
  "homedir": "\/demo",
  "expire_time": "1414150244",
  "bytes_in_avail": "0",
  "admin": "Y",
  "active": "Y",
  "lockedout": "N",
  "ftp_active": "Y",
  "ftps_active": "Y",
  "ftp_filelist": "Y",
  "ftp_download": "Y",
  "ftp_upload": "Y",
  "ftp_overwrite": "Y",
  "ftp_delete": "Y",
  "sftp_active": "Y",
  "sftp_filelist": "Y",
  "sftp_download": "Y",
  "sftp_upload": "Y",
  "sftp_overwrite": "Y",
  "sftp_delete": "Y",
  "http_active": "Y",
  "https_active": "Y",
  "web_filelist": "Y",
  "web_download": "Y",
  "web_upload": "Y",
  "web_overwrite": "Y",
  "web_delete": "Y",
  "web_manage": "Y",
  "web_media": "Y",
  "web_notification": "Y",
  "email": "john.smith@example.com",
  "recover_email": null,
  "passwordless_link": "http:\/\/demo.ftpstream.com\/?lid=<random_string>",
  "secure_passwordless_link": "https:\/\/demo.ftpstream.com\/?lid=<random_string>"
}

<uuid> - universally unique User ID identifier. Read only.
<login> * - User ID login used for file access. Unique. 3-20 lower/upper case characters or numbers. Required.
<password> * - User ID password used for file access. Password should be between 6 to 25 any characters except spaces. Password can not be same as login. Required.
<real_name> * - User ID real name. Required.
<homedir> * - User ID home directory. Required.
<expire_time> - User ID expiration time. Seconds scince 1 January 1970. Default 1 January 2100.
<bytes_in_avail> - User ID disc space limit in bytes. Default 0 - no limit.
<admin> - Flag which grants admin rights to User ID. Values 'Y' or 'N'. Default 'N'.
<active> - Flag which indicates whether User ID active. Values 'Y' or 'N'. Default 'Y'.
<recover_email> - User ID email used for password recovery. Works only with Enhanced Security optional module.
<lockedout> - Flag which indicates whether User ID lockedout. Values 'Y' or 'N'. Default 'N'.
<ftp_active> - Flag to enable FTP protocol for User ID. Values 'Y' or 'N'. Default 'Y'.
<ftps_active> - Flag to enable FTPS protocol for User ID. Values 'Y' or 'N'. Default 'Y'.
<ftp_filelist> - Flag to allow FTP/FTPS filelisting. Values 'Y' or 'N'. Default 'Y'.
<ftp_download> - Flag to allow FTP/FTPS download. Values 'Y' or 'N'. Default 'Y'.
<ftp_upload> - Flag to allow FTP/FTPS upload. Values 'Y' or 'N'. Default 'Y'.
<ftp_overwrite> - Flag to allow FTP/FTPS file overwrite during upload. Values 'Y' or 'N'. Default 'Y'.
<ftp_delete> - Flag to allow FTP/FTPS file delete. Values 'Y' or 'N'. Default 'Y'.
<sftp_active> - Flag to enable SFTP protocol for User ID. Values 'Y' or 'N'. Default 'Y'.
<sftp_filelist> - Flag to allow SFTP filelisting. Values 'Y' or 'N'. Default 'Y'.
<sftp_download> - Flag to allow SFTP download. Values 'Y' or 'N'. Default 'Y'.
<sftp_upload> - Flag to allow SFTP upload. Values 'Y' or 'N'. Default 'Y'.
<sftp_overwrite> - Flag to allow SFTP file overwrite during upload. Values 'Y' or 'N'. Default 'Y'.
<sftp_delete> - Flag to allow SFTP file delete. Values 'Y' or 'N'. Default 'Y'.
<http_active> - Flag to enable web HTTP protocol for User ID. Values 'Y' or 'N'. Default 'Y'.
<https_active> - Flag to enable web HTTPS protocol for User ID. Values 'Y' or 'N'. Default 'Y'.
<web_filelist> - Flag to allow web filelisting. Values 'Y' or 'N'. Default 'Y'.
<web_download> - Flag to allow web download. Values 'Y' or 'N'. Default 'Y'.
<web_upload> - Flag to allow web upload. Values 'Y' or 'N'. Default 'Y'.
<web_overwrite> - Flag to allow web file overwrite during upload. Values 'Y' or 'N'. Default 'Y'.
<web_delete> - Flag to allow web file delete. Values 'Y' or 'N'. Default 'Y'.
<web_manage> - Flag to grant web file management functions. Values 'Y' or 'N'. Default 'Y'.
<web_media> - Flag to grant web video functions. Values 'Y' or 'N'. Default 'N'. Video available only with Video optional module.
<web_notification> - Flag to enable email advice on web upload. Default 'N'.
<email> - Email address for upload advices.
<passwordless_link> - User ID passwordless web link. Read only.
<secure_passwordless_link> - User ID passwordless secure web link. Read only.