Get all site users

Description

Returns all site users and their properties.

URL

/qcbin/v2/sa/api/site-users

HTTP Method

GET

Remarks

To avoid stress on the database server when there are a large number of site users, restrict the size of data returned by the query by filtering and retrieving only the required data.

It can indicate the total number of site users to return in each page using the query parameter page-size. For example: /qcbin/v2/sa/api/site-users?page-size=20

If a page size is not specified in the query, the number of returned entities on each page is the value of the site parameter REST_API_DEFAULT_PAGE_SIZE. If the site parameter is not defined, the page size is 100.

It can indicate the position of the next site user to retrieve with the query parameter start-index. For example: /qcbin/v2/sa/api/site-users?start-index=2

These two query parameters can be used together. For example: /qcbin/v2/sa/api/site-users?start-index=5&page-size=30

Accept: application/xml, application/json

Returns

On success, the HTTP return value is 200.

On success, returns the full data of all the site users in an XML/JSON string compliant with the Site users schema reference.

Return Value Example