6.1.1.3.2.31. linotp.lib.user module

contains user - related functions

class linotp.lib.user.User(login='', realm='', conf='')

Bases: object

addResolverUId(resolver, uid, conf='', resId='', resCId='')

getRealm()

getResConf()

getResolverConf(resolver)

getResolverUId(resolver)

getResolvers()

getUser()

isEmpty()

saveResolvers(resolvers)

save the resolver objects as list as part of the user

linotp.lib.user.check_user_password(username, realm, password)

This is a helper function to check the username and password against a userstore.

return

success — This is the username of the authenticated user. If unsuccessful,

returns None

linotp.lib.user.getConf(Realms, Conf)

extract the configguration part from the resolver definition

linotp.lib.user.getRealmBox()

returns the config value of selfservice.realmbox. if True, the realmbox in the selfservice login will be displayed. if False, the realmbox will not be displayed and the user needs to login via user@realm

linotp.lib.user.getResolvers(user)

get the list of the Resolvers within a users.realm or from the resolver conf, if given in the user object

Note :It ignores the user.login attribute! Parameters:user (User object) – User with realm or resolver conf

linotp.lib.user.getResolversOfUser(user)

This returns the list of the Resolvers of a user in a given realm. Usually this should only return one resolver

input:

user.login, user.realm

returns:

array of resolvers, the user was found in

linotp.lib.user.getSearchFields(User)

linotp.lib.user.getUserFromParam(param, optionalOrRequired)

linotp.lib.user.getUserFromRequest(request)

This function first tries to get the user from * a DigestAuth and otherwise from * basic auth and otherwise from * the client certificate

linotp.lib.user.getUserId(userObject)

return (uid,resId,resIdC)

linotp.lib.user.getUserInfo(userid, resolver, resolverC)

linotp.lib.user.getUserList(param, User)

linotp.lib.user.getUserPhone(user, phone_type='phone')

Returns the phone numer of a user

Parameters:

• user (user object) – the user with the phone
• phone_type (string) – The type of the phone, i.e. either mobile or phone (land line)

Returns:

list with phone numbers of this user object

linotp.lib.user.getUserRealms(user)

Returns the realms, a user belongs to. If the user has no realm but only a useridresolver, than all realms, containing this resolver are returned. This function is used for the policy module

linotp.lib.user.getUserResolverId(user, report=False)

linotp.lib.user.setRealm(realm, resolvers)

linotp.lib.user.splitUser(username)