6.1.1.3.2.20. linotp.lib.realm module¶
realm processing logic
- linotp.lib.realm.createDBRealm(realm)[source]¶
Store Realm in the DB Realm Table. If the realm already exist, we do not need to store it
Parameters: realm (string) – the realm name :return : if realm is created(True) or already esists(False) :rtype : boolean
- linotp.lib.realm.deleteRealm(realmname)[source]¶
delete the realm from the Database Table with the given name
Parameters: realmname (string) – the to be deleted realm
- linotp.lib.realm.getDefaultRealm()[source]¶
return the default realm - lookup in the config for the DefaultRealm key
Returns: the realm name :rtype : string
- linotp.lib.realm.getRealmObject(name=u'', id=0)[source]¶
returns the Realm Object for a given realm name. If the given realm name is not found, it returns “None”
Parameters: name (string) – realmname to be searched TODO: search by id not implemented, yet :param id: id of the realm object :type id: integer
:return : realmObject - the database object :rtype : the sql db object
- linotp.lib.realm.getRealms(aRealmName='')[source]¶
lookup for a defined realm or all realms
Note : the realms dict is inserted into the LinOtp Config object so that a lookup has not to reparse the whole config again
Parameters: aRealmName (string) – a realmname - the realm, that is of interestet, if ==”” all realms are returned Returns: a dict with realm description like - :rtype : dict : {
- u’myotherrealm’: {‘realmname’: u’myotherrealm’,
- ‘useridresolver’: [‘useridresolver.PasswdIdResolver.IdResolver.myOtherRes’], ‘entry’: u’linotp.useridresolver.group.myotherrealm’},
- u’mydefrealm’: {‘default’: ‘true’,
- ‘realmname’: u’mydefrealm’, ‘useridresolver’: [‘useridresolver.PasswdIdResolver.IdResolver.myDefRes’], ‘entry’: u’linotp.useridresolver.group.mydefrealm’},
- u’mymixrealm’: {‘realmname’: u’mymixrealm’,
- ‘useridresolver’: [‘useridresolver.PasswdIdResolver.IdResolver.myOtherRes’, ‘useridresolver.PasswdIdResolver.IdResolver.myDefRes’], ‘entry’: u’linotp.useridresolver.group.mymixrealm’}}
- linotp.lib.realm.isRealmDefined(realm)[source]¶
check, if a realm already exists or not
Parameters: realm (string) – the realm, that should be verified :return :found or not found :rtype :boolean