User—Get List

This API allows an administrator to get a list of users.

URI:

https://<FQDN>/finesse/api/Users

Example URI:

https://finesse1.xyz.com/finesse/api/Users

Security Constraints:

Only administrators can get a list of users.

To get a list of users, the administrator must be signed in or provide valid authorization credentials when challenged.

HTTP Method:

GET

Content Type:

—

Input/Output Format:

XML

HTTP Request:

—

HTTP Response:

200: Success

401: Authorization Failure

500: Internal Server Error

503: Service Unavailable

Example Response: 

<Users>
   <User>
      ... Full User Object ...
   </User>
   <User>
      ... Full User Object ...
   </User>
   <User>
      ... Full User Object ...
   </User>
   <User>
      ... Full User Object ...
   </User>
   <User>
      ... Full User Object ...
   </User>
      ... Additional Users...
</Users>

Example Failure Response: 

<ApiErrors>
  <ApiError>
    <ErrorType>Unauthorized</ErrorType>
    <ErrorMessage>The user is not authorized to perform
     this operation</ErrorMessage>
  </ApiError>
</ApiErrors>