Class ExtendedUserSerializer

src/backend/InvenTree/users/serializers.py:301–366

Serializer for a User with a bit more info.

class ExtendedUserSerializer(UserSerializer):
    """Serializer for a User with a bit more info."""

    # from users.serializers import GroupSerializer

    class Meta(UserSerializer.Meta):
        """Metaclass defines serializer fields."""

        fields = [
            *UserSerializer.Meta.fields,
            'groups',
            'group_ids',
            'is_staff',
            'is_superuser',
            'is_active',
            'profile',
        ]

        read_only_fields = [*UserSerializer.Meta.read_only_fields, 'groups']

    groups = GroupSerializer(many=True, read_only=True)

    # Write-only field, for updating the groups associated with the user
    group_ids = serializers.PrimaryKeyRelatedField(
        queryset=Group.objects.all(), many=True, write_only=True, required=False
    )

    is_staff = serializers.BooleanField(
        label=_('Administrator'),
        help_text=_('Does this user have administrative permissions'),
        required=False,
    )

    is_superuser = serializers.BooleanField(
        label=_('Superuser'), help_text=_('Is this user a superuser'), required=False
    )

    is_active = serializers.BooleanField(
        label=_('Active'), help_text=_('Is this user account active'), required=False
    )

    profile = BriefUserProfileSerializer(many=False, read_only=True)

    def validate_is_superuser(self, value):
        """Only a superuser account can adjust this value!"""
        request_user = self.context['request'].user

        if 'is_superuser' in self.context['request'].data:
            if not request_user.is_superuser:
                raise PermissionDenied({
                    'is_superuser': _('Only a superuser can adjust this field')
                })

        return value

    def update(self, instance, validated_data):
        """Update the user instance with the provided data."""
        # Update the groups associated with the user