List Admin

<< Click to Display Table of Contents >>

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

List Admin

Lists all administrative profiles available for a virtual server.

 

Request

Method

URL

POST

/smserver/smsadm.ListAdmin

RAW

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

}

]

Explained

Retrieves the list of all administrative profiles associated to a certain virtual server.

 

vserver: the virtual server name

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

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

 

 

{"result":[

[

       {

           "VServer" : "default",

           "_id" : "YRSH3CVFQAXU3OAWAVIKM4HBJQ",

           "Username" : "admin",

           "AccountStatus" : "Enabled",

           "AdminRole" : "Admin"

       }

   ]

],"id":7721}

Explained

A JSON array with all administrative profiles that exist on the specified virtual server.

 

For each admin profile, the following properties are returned:

_id: unique ID of the admin profile

Username: Username of this administrator

AccountStatus: current status "Enabled" or "Disabled"

AdminRole: role of this admin "Admin", "ViewOnly", "DashboardOnly"