Routes

Swagger UI

Check out /api-docs if you'd like to visualize and interact with the API's resources without having any of the implementation logic in place.

 

Users overview

path: /api/users

Resource	Method	Description
/	GET	List of users
/	POST	Add user
/<user_id>	GET	Show user
/<user_id>	DELETE	Delete user
/<user_id>	PUT	Update user
/<user_id>/authenticate	POST	Authenticate user
/<user_id>/groups	GET	List of memberships
/<user_id>/enable	PUT	Enable user
/<user_id>/disable	PUT	Disable user
/<user_id>/password	PUT	Set password
/<user_id>/unlock	PUT	Unlock user
/<user_id>/pw-never-expires	PUT	Set password never expires

 

Groups overview

Resource	Method	Description
/	GET	List of groups
/	POST	Add group
/<group_id>	GET	Show group
/<group_id>	DELETE	Delete group
/<group_id>	PUT	Update group
/<group_id>/members	GET	List of members
/<group_id>/members	POST	Add member to group
/<group_id>/members/<user_id>	POST	Remove membership