restauth_user - user handling

The restauth_user module includes all code related to user management. You can use one of the factory methods (get(), get_all() or create()) to retreive an instance or a list of instances of the User class.

The factory methods make sure that the User object used represents a user that actually exists in the RestAuth service by verifying the existance for returning the respective instance(s). If performance is critical, however, it is better to instantiate an instance directly, perform the desired operations on that object and catch the case of a non-existing user with an exception handler.

from RestAuthClient import common, restauth_user
conn = common.RestAuthConnection( 'https://auth.example.com', 'service', 'password' )

# this is two requests:
user = restauth_user.get( 'username' ) # does one request
user.verify_password( 'password' )

# this is just one request:
user = restauth_user.User( 'username' ) # does no request
user.verify_password( 'password' )

API documentation

Table Of Contents

Previous topic

common - Common code used by other classes

Next topic

group - group handling

This Page