user_getAll.rst

user_getAll

GET /users

Summary

• Method: GET
• Response Code: 200 / 304
• Response Formats: application/xml application/json
• Since: UForge 1.0

Retrieves all the users in the platform. A list of user-object objects are returned.

You can use a search criteria or a set of query parameters to retrieve a subset of the users.

Security Summary

• Requires Authentication: true
• Entitlements Required: user_administrate

URI Parameters

None HTTP Request Body Parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

None

Example Request

curl "https://uforge.example.com/api/users" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

• user-object
• userAdminStatus-change
• userOrg-getAll
• userOrg-remove
• user-create
• user-get
• user-update