Ldap user

LdapUser

Bases: DomainObject

Represents an entry mapping a ldap id to a CKAN user.

Source code in ckanext/ldap/model/ldap_user.py

class LdapUser(model.domain_object.DomainObject):
    """
    Represents an entry mapping a ldap id to a CKAN user.
    """

    @classmethod
    def by_ldap_id(cls, ldap_id, autoflush=True):
        """
        Return the LdapUser object mapping the given ldap id.

        :param ldap_id: ldap id, as returned by the LDAP server
        :param autoflush: (Default value = True)
        :returns: LdapUser object or None
        """
        obj = (
            model.meta.Session.query(cls)
            .autoflush(autoflush)
            .filter_by(ldap_id=ldap_id)
            .first()
        )
        return obj

    @classmethod
    def by_user_id(cls, user_id, autoflush=True):
        """
        Return the LdapUser object mapping the given user id.

        :param user_id: CKAN user id (actual id, not name)
        :param autoflush: (Default value = True)
        :returns: LdapUser object or None
        """
        obj = (
            model.meta.Session.query(cls)
            .autoflush(autoflush)
            .filter_by(user_id=user_id)
            .first()
        )
        return obj

by_ldap_id(ldap_id, autoflush=True) classmethod

Return the LdapUser object mapping the given ldap id.

Parameters:

Name	Type	Description	Default
ldap_id		ldap id, as returned by the LDAP server	required
autoflush		(Default value = True)	True

Returns:

Type	Description
	LdapUser object or None

Source code in ckanext/ldap/model/ldap_user.py

@classmethod
def by_ldap_id(cls, ldap_id, autoflush=True):
    """
    Return the LdapUser object mapping the given ldap id.

    :param ldap_id: ldap id, as returned by the LDAP server
    :param autoflush: (Default value = True)
    :returns: LdapUser object or None
    """
    obj = (
        model.meta.Session.query(cls)
        .autoflush(autoflush)
        .filter_by(ldap_id=ldap_id)
        .first()
    )
    return obj

by_user_id(user_id, autoflush=True) classmethod

Return the LdapUser object mapping the given user id.

Parameters:

Name	Type	Description	Default
user_id		CKAN user id (actual id, not name)	required
autoflush		(Default value = True)	True

Returns:

Type	Description
	LdapUser object or None

Source code in ckanext/ldap/model/ldap_user.py

@classmethod
def by_user_id(cls, user_id, autoflush=True):
    """
    Return the LdapUser object mapping the given user id.

    :param user_id: CKAN user id (actual id, not name)
    :param autoflush: (Default value = True)
    :returns: LdapUser object or None
    """
    obj = (
        model.meta.Session.query(cls)
        .autoflush(autoflush)
        .filter_by(user_id=user_id)
        .first()
    )
    return obj