API quick reference

Overview

The table below lists all available API calls and methods - the content is provided following a CRUD pattern or workflows involved, and for each main block of functionality links to both relevant topics and to detailed API references are given.

Quick reference

Topic REST Python
Users    
User.create POST /zato/sso/user self.sso.user.create
User.signup POST /zato/sso/user/signup self.sso.user.signup
User.confirm_signup PATCH /zato/sso/user/signup self.sso.user.confirm_signup
User.approve POST /zato/sso/user/approve self.sso.user.approve
User.reject POST /zato/sso/user/reject self.sso.user.reject
User.login POST /zato/sso/user/login self.sso.user.login
User.logout POST /zato/sso/user/logout self.sso.user.logout
User.get GET /zato/sso/user self.sso.user.get_user_by_*
User.search GET /zato/sso/user/search self.sso.user.search
User.update PATCH /zato/sso/user self.sso.user.update
User.delete DELETE /zato/sso/user self.sso.user.delete
User.change_password PATCH /zato/sso/user/password self.sso.user.change_password
   
Super-users    
SuperUser.create self.sso.user.create_super_user
   
Sessions    
Session.verify POST /zato/sso/session self.sso.user.session.verify
Session.renew PATCH /zato/sso/session self.sso.user.session.renew
Session.get GET /zato/sso/session self.sso.user.session.get
   
User attributes    
create/create_many POST /zato/sso/user/attr self.sso.user.session.attr.create/create_many
update/update_many PATCH /zato/sso/user/attr self.sso.user.session.attr.update/update_many
set/set_many PUT /zato/sso/user/attr self.sso.user.session.attr.set/set_many
delete/delete_many DELETE /zato/sso/user/attr self.sso.user.session.attr.delete/delete_many
get/get_many GET /zato/sso/user/attr self.sso.user.session.attr.get/get_many
exists/exists_many GET /zato/sso/user/attr/exists self.sso.user.session.attr.exists/exists_many
names GET /zato/sso/user/attr/names self.sso.user.session.attr.names
   
Session attributes    
create/create_many POST /zato/sso/session/attr self.sso.user.session.attr.create/create_many
update/update_many PATCH /zato/sso/session/attr self.sso.user.session.attr.update/update_many
set/set_many PUT /zato/sso/session/attr self.sso.user.session.attr.set/set_many
delete/delete_many DELETE /zato/sso/session/attr self.sso.user.session.attr.delete/delete_many
get/get_many GET /zato/sso/session/attr self.sso.user.session.attr.get/get_many
exists/exists_many GET /zato/sso/session/attr/exists self.sso.user.session.attr.exists/exists_many
names GET /zato/sso/session/attr/names self.sso.user.session.attr.names

More information