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.

Permission to run the request: Account Owner, Administrator, Organization Administrator.

 

Request Headers

ParameterDescription
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.

 

Possible Response Codes

CodeTextDescription
403Permission denied

Not enough permissions to handle the request.

Example: Organization admin can't request info about users from another organization.

200OkThe request has been processed successfully.

 

Sample Request

 

Sample Response

The <deactivationDate/> value will be included in the response only if a deactivation date was previously set for a user profile.

 

  •