Load Admin

<< Click to Display Table of Contents >>

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

Load Admin

Loads an administrative profile from the database.

 

Request

Method

URL

POST

/smserver/smsadm.LoadAdmin

RAW

POST /smserver/smsadm.LoadAdmin 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

 

[{"vserver":"default","AUName":"admin"}]

Explained

LoadAdmin loads an administrator's profile from a virtual server.

 

vserver: the virtual server name

AUName: the username of the admin profile to be loaded

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

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

 

 

{"result":[

"_id" : "YRSH3CVFQAXU3OAWAVIKM4HBJQ",

       "Username" : "admin",

       "PHType" : "V4Plus",

       "Salt" : "91227861",

       "Password" : "dd10e5be0ffadd64c1e490fbdefa64d8eb4a21380e29d521d1f0affdb44afbe798b4c320ee24257813c6dce4ef43fc56e1f4c625e4a76559ec0372c1738b8728",

       "AdminRole" : "Admin",

       "AccountStatus" : "Enabled",

       "AutoDisable" : false,

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

       "AllowedIPs" : []

 

],"id":772674711}

Explained

The "result" object contains the entire profile of the loaded administrative account:

 

_id: unique ID of the admin profile

Username: username that this administrator will use to log in

PHType: password type ("Legacy" or "V4Plus") (1)

Salt: random salt value (1)

Password: password Hash (1)

AdminRole: the role of this specific admin profile ("Admin", "ViewOnly", or "DashboardOnly")

AccountStatus: "Enabled" or "Disabled"

AutoDisable: true or false, if true the account will be disable past the AutoDisableWhen date

AutoDisableWhen: date when this account has to be disabled

AllowedIPs: white-list (JSON array) - if not empty, then this administrator can only log in from one of these IPs and networks

 

Note:

(1) these values cannot be manipulated directly, only through the PassUtil API function.