Page tree
Skip to end of metadata
Go to start of metadata

You can obtain the list of users by sending the GET request to the following URL: /user.

Request Headers

ParameterDescription
X-Auth-Account-Url (required)Base URL of the account, e.g. http://myaccount.ispringlearn.com
X-Auth-Email (required)Administrator/Publisher e-mail address.
X-Auth-Password (required)Administrator/Publisher password.
X-Group-Id (optional)If specified, this header selects users belonging to a given group.

After the request has been completed, the system returns the response with Code 200. The body of the response will contain xml data with information on users.

Possible Response Codes

CodeTextDescription
200OkThe request has been processed successfully.

 

Sample Request

GET /user HTTP/1.1
Host: api.ispringonline.com
X
-Auth-Account-Url: http://myaccount.ispringonline.com
X
-Auth-Email: email@email.com
X
-Auth-Password: password

Sample Response

HTTP/1.1 200 OK
Server: nginx
Connection: close

<?xml version="1.0" encoding="utf-8"?>
<users>
 
<userProfile>
   
<userId>1</userId>
    <email>user@email.com</
email>
   
<name>User</name>
    …
    <groups>
      <id>1</
id>
     
<id>2</id>
    </
groups>
 
</userProfile>
  <userProfile>
    …
  </
userProfile>
</users>
  •