Read users list

<< Click to Display Table of Contents >>

Navigation:  Managing Syncplify.me Server! > REST API > Admin API > User Management >

Read users list

Reads the entire list of users available to a virtual server.

 

Request

Method

URL

POST

/smserver-default/sms.ReadUserList

RAW

POST /smserver-default/sms.ReadUserList HTTP/1.1

Cache-Control: no-cache

Connection: Keep-Alive

Pragma: no-cache

Content-Type: application/json; charset=UTF-8

Accept: */*

Authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

 

[

{}

]

Explained

Returns a list of all user objects (the entire user profile is returned for each user object).

 

Payload: a JSON array containing a single empty object.

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

Content-Type: application/json; charset=UTF-8

 

 

{"result":[

[

       {

           "_id" : "YW7IBR7WPHHE3FZXWAEDDLFRWY",

           "UserType" : "SMS",

           "Username" : "smserver",

           "RemapDomain" : "",

           "Description" : "",

           "PHType" : "V4Plus",

           "Salt" : "EDAA5D31",

           "Password" : "d6e37554d5d42c50152a9e90013dfa4c09cb694317e6715d9545ffacfc22a022cf152384be6a611dbdefcdb76acbd3d788dd3434dab00dfb03553457890a9694",

           "PubKeys" : [

               {

                   "KeyName" : "usr.rsa",

                   "Key" : ""

               }

           ],

           "Home" : {

               "MountPoint" : "/",

               "VFSItemID" : "KVFPSTBWKZHUTBHZ3RJDLK7EOA",

               "Visible" : true,

               "Permissions" : {

                   "canGetFile" : true,

                   "canPutFile" : true,

                   "canDelFile" : true,

                   "canModFile" : true,

                   "canRenFile" : true,

                   "canListDir" : true,

                   "canMakeDir" : true,

                   "canDelDir" : true,

                   "canRenDir" : true

               },

               "ImpType" : "None",

               "ImpUser" : "",

               "ImpPass" : ""

           },

           "VirtualFolders" : null,

           "AuthTypes" : [

               "Password"

           ],

           "AuthAll" : false,

           "AllowPlainFTP" : false,

           "AllowExplicitFTPS" : true,

           "AllowImplicitFTPS" : true,

           "AllowSSH" : false,

           "AllowSFTP" : true,

           "AllowForward" : false,

           "AllowWebDAV" : false,

           "AccountStatus" : "Enabled",

           "AutoEnable" : false,

           "EnabledAsOf" : "1899-12-31",

           "AutoDisable" : false,

           "AutoDisableWhen" : "1899-12-31",

           "AllowedIPs" : null,

           "AllowedFwd" : null,

           "SpeedLimits" : null,

           "EventHandlers" : null

       },

       {

           "_id" : "MAZ3LIRCVVBEJBGUHATZDARGMM",

           "UserType" : "SMS",

           "Username" : "pippo",

           "RemapDomain" : "",

           "Description" : "",

           "PHType" : "V4Plus",

           "Salt" : "3080944B",

           "Password" : "db42c10eb3981b1533927e5440a4df61804e81fcd9d31c9db56eaee65a524285edd67cba85d96a73a49addb5cb20ebe1827625195c7fe3b40d1f21ee55cf0eba",

           "PubKeys" : null,

           "Home" : {

               "MountPoint" : "/",

               "VFSItemID" : "KVFPSTBWKZHUTBHZ3RJDLK7EOA",

               "Visible" : true,

               "Permissions" : {

                   "canGetFile" : true,

                   "canPutFile" : false,

                   "canDelFile" : false,

                   "canModFile" : false,

                   "canRenFile" : false,

                   "canListDir" : true,

                   "canMakeDir" : false,

                   "canDelDir" : false,

                   "canRenDir" : false

               },

               "ImpType" : "None",

               "ImpUser" : "",

               "ImpPass" : ""

           },

           "VirtualFolders" : null,

           "AuthTypes" : [

               "Password"

           ],

           "AuthAll" : false,

           "AllowPlainFTP" : false,

           "AllowExplicitFTPS" : true,

           "AllowImplicitFTPS" : true,

           "AllowSSH" : false,

           "AllowSFTP" : true,

           "AllowForward" : false,

           "AllowWebDAV" : false,

           "AccountStatus" : "Enabled",

           "AutoEnable" : false,

           "EnabledAsOf" : "1899-12-31",

           "AutoDisable" : false,

           "AutoDisableWhen" : "1899-12-31",

           "AllowedIPs" : null,

           "AllowedFwd" : null,

           "SpeedLimits" : null,

           "EventHandlers" : null

       }

   ]

],"id":772674711}

Explained

Result: a JSON array, each element of the array is a JSON object representing a full user profile.