SSO 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

Users

Topic REST Python
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
User.lock POST /zato/sso/user/lock self.sso.user.lock_user
User.unlock DELETE /zato/sso/user/lock self.sso.user.unlock_user
User.reset_totp_key PATCH /zato/sso/user/totp self.sso.user.reset_totp_key
SuperUser.create --- self.sso.user.create_super_user

Sessions

Topic REST Python
Session.verify POST /zato/sso/user/session self.sso.user.session.verify
Session.renew PATCH /zato/sso/user/session self.sso.user.session.renew
Session.get GET /zato/sso/user/session self.sso.user.session.get
Session.get_list GET /zato/sso/user/session/list self.sso.user.session.get_list

User attributes

Topic REST Python
create/create_many POST /zato/sso/user/attr self.sso.user.attr.create*
update/update_many PATCH /zato/sso/user/attr self.sso.user.attr.update*
set/set_many PUT /zato/sso/user/attr self.sso.user.attr.set*
delete/delete_many DELETE /zato/sso/user/attr self.sso.user.attr.delete*
get/get_many GET /zato/sso/user/attr self.sso.user.attr.get*
exists/exists_many GET /zato/sso/user/attr/exists self.sso.user.attr.exists*
names GET /zato/sso/user/attr/names self.sso.user.attr.names

Session attributes

Topic REST Python
create/create_many POST /zato/sso/session/attr self.sso.user.session.attr.create*
update/update_many PATCH /zato/sso/session/attr self.sso.user.session.attr.update*
set/set_many PUT /zato/sso/session/attr self.sso.user.session.attr.set*
delete/delete_many DELETE /zato/sso/session/attr self.sso.user.session.attr.delete*
get/get_many GET /zato/sso/session/attr self.sso.user.session.attr.get*
exists/exists_many GET /zato/sso/session/attr/exists self.sso.user.session.attr.exists*
names GET /zato/sso/session/attr/names self.sso.user.session.attr.names

Password reset

Topic REST Python
create_token POST /zato/sso/password/reset self.sso.password_reset.create_token
access_token PATCH /zato/sso/password/reset self.sso.password_reset.access_token
change_password DELETE /zato/sso/password/reset self.sso.password_reset.change_password

Linked auth

Topic REST Python
LinkedAuth.create POST /zato/sso/user/linked self.sso.user.create_linked_auth
LinkedAuth.get GET /zato/sso/user/linked self.sso.user.get_linked_auth_list
LinkedAuth.delete DELETE /zato/sso/user/linked self.sso.user.delete_linked_auth

More information