Class UserDB

st2common/st2common/models/db/auth.py:31–65

An entity representing system user. Attribute: name: Username. Also used as a primary key and foreign key when referencing users in other models. is_service: True if this is a service account. nicknames: Nickname + origin pairs for ChatOps auth.

class UserDB(stormbase.StormFoundationDB):
    """
    An entity representing system user.

    Attribute:
        name: Username. Also used as a primary key and foreign key when referencing users in other
              models.
        is_service: True if this is a service account.
        nicknames: Nickname + origin pairs for ChatOps auth.
    """

    name = me.StringField(required=True, unique=True)
    is_service = me.BooleanField(required=True, default=False)
    nicknames = me.DictField(
        required=False, help_text='"Nickname + origin" pairs for ChatOps auth'
    )

    def get_roles(self, include_remote=True):
        """
        Retrieve roles assigned to that user.

        :param include_remote: True to also include remote role assignments.
        :type include_remote: ``bool``

        :rtype: ``list`` of :class:`RoleDB`
        """
        rbac_service = get_rbac_backend().get_service_class()
        result = rbac_service.get_roles_for_user(
            user_db=self, include_remote=include_remote
        )
        return result

    def get_permission_assignments(self):
        # TODO
        pass


class TokenDB(stormbase.StormFoundationDB):