Class OrganisationSerializerFull

api/organisations/serializers.py:40–73

class OrganisationSerializerFull(serializers.ModelSerializer):  # type: ignore[type-arg]
    subscription = SubscriptionSerializer(required=False)
    role = serializers.SerializerMethodField()

    class Meta:
        model = Organisation
        fields = (
            "id",
            "uuid",
            "name",
            "created_date",
            "webhook_notification_email",
            "num_seats",
            "subscription",
            "role",
            "persist_trait_data",
            "block_access_to_admin",
            "restrict_project_create_to_admin",
            "force_2fa",
        )
        read_only_fields = (
            "id",
            "created_date",
            "num_seats",
            "role",
            "persist_trait_data",
            "block_access_to_admin",
        )

    @extend_schema_field({"type": "string", "nullable": True})
    def get_role(self, instance):  # type: ignore[no-untyped-def]
        if self.context.get("request"):
            user = self.context["request"].user
            return user.get_organisation_role(instance)


class OrganisationSerializerBasic(serializers.ModelSerializer):  # type: ignore[type-arg]