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

You can obtain the list of users with the getUsers method.

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

 

Parameters

ParameterTypeDescription
credentials (required)credentialsRead the description of the Credentials object.
groupId (optional)stringIf specified, this method selects users belonging to a specific group.
organizationId (optional)intIf specified, this header selects users belonging to a specific organization.


Return Value

After the request has been completed, the system returns an object with the following properties:

ParameterTypeDescription
usersUserProfile[]Array of user profiles. The UserProfile object has the same properties as the getUserProfile method.


Possible Errors

ErrorDescription
Permission denied

The user doesn't have enough permissions to handle the request.

For example, an organization admin can't request info about users from another organization.


Sample Call

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="http://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <GetUsersRequest>
      <credentials>
        <accountUrl>http://myaccount.ispringlearn.com</accountUrl>
        <email>email@email.com</email>
        <password>password</password>
      </credentials>
    </GetUsersRequest>
    <groupId>1</groupId>
    <organizationId>2</organizationId>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample Response

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="http://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <GetUsersResult>
      <userProfile>
        <userId>string</userId>
        …
      </userProfile>
      <userProfile>
        <userId>string</userId>
        …
      </userProfile>
    </GetUsersResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • No labels