You can obtain the list of users by sending the GET request to the following URL: /user.
Permission to run the request: Account Owner, Administrator, Organization Administrator.
Parameter | Description |
---|---|
X-Auth-Account-Url (required) | Base URL of the account, e.g. http://myaccount.ispringlearn.com |
X-Auth-Email (required) | Administrator/Organization Administrator e-mail address. |
X-Auth-Password (required) | Administrator/Organization Administrator password. |
X-Organization-Id (optional) | If specified, this header selects users belonging to a given organization. |
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.
Code | Text | Description |
---|---|---|
403 | Permission denied | Not enough permissions to handle the request. Example: Organization admin can't request info about users from another organization. |
200 | Ok | The request has been processed successfully. |
GET /user HTTP/1.1 Host: api.ispringonline.com X-Auth-Account-Url: http://myaccount.ispringlearn.com X-Auth-Email: email@email.com X-Auth-Password: password X-Organization-Id: 1 X-Group-Id |
HTTP/1.1 200 OK Connection: close <?xml version="1.0" encoding="UTF-8"?> <users> <userProfile> <userId>1</userId> <status>1</status> <role>publisher</role> <organizationId>1</organizationId> <deactivationDate>2017-11-29</deactivationDate> <groups> <id>2</id> ... </groups> <fields> <login>user</login> <first_name/> <last_name/> <email>user@email.com</email> <country_id/> ... </fields> </userProfile> <userProfile> <userId>2</userId> <status>1</status> <role>user</role> <organizationId>1</organizationId> <groups> <id>2</id> ... </groups> <fields> <login>user1</login> <first_name/> <last_name/> <email>user1@email.com</email> <country_id/> ... </fields> </userProfile> </users> |
The <deactivationDate/> value will be included in the response only if a deactivation date was previously set for a user profile.